]> git.immae.eu Git - github/wallabag/wallabag.git/blobdiff - docs/en/User_documentation/Hidden_options.html
upgrade documentation
[github/wallabag/wallabag.git] / docs / en / User_documentation / Hidden_options.html
index 6542081386e0a33a82a1d2f92750381fe92853d4..83c9668b4f7b36e1724a49fba1893625242867ab 100644 (file)
@@ -5,7 +5,7 @@
 <!--[if gt IE 8]><!-->  <html class="no-js" lang="en"> <!--<![endif]-->
 <head>
     <title>Hidden options</title>
-    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+    <meta charset="utf-8">
     <meta name="description" content="Documentation for wallabag" />
     <meta name="author" content="Nicolas Lœuillet">
     <link rel="icon" href="../../templates/default/themes/daux-blue/img/favicon-blue.png" type="image/x-icon">
@@ -14,7 +14,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
     <!-- Font -->
-    <link href='//fonts.googleapis.com/css?family=Roboto+Slab:400,100,300,700&subset=latin,cyrillic-ext,cyrillic' rel='stylesheet' type='text/css'>
+    
     <!-- CSS -->
     <link href='../../templates/default/themes/daux-blue/css/daux-blue.css' rel='stylesheet' type='text/css'>
 </head>
@@ -39,7 +39,7 @@
                     </div>
                     <div id="sub-nav-collapse" class="sub-nav-collapse">
                         <!-- Navigation -->
-                        <ul class="nav nav-list"><li><a href="../../en/Getting_started.html">Getting started</a></li><li><a href="../../en/Help_wallabag.html">Help wallabag</a></li><li class="open"><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="../../en/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="../../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li class="active"><a href="../../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li><li><a href="#" class="aj-nav folder">Technical documentation</a><ul class="nav nav-list"></ul></li></ul>                                                    <div class="well well-sidebar">
+                        <ul class="nav nav-list"><li><a href="../../en/Getting_started.html">Getting started</a></li><li><a href="../../en/Help_wallabag.html">Help wallabag</a></li><li class="open"><a href="#" class="aj-nav folder">User documentation</a><ul class="nav nav-list"><li><a href="../../en/User_documentation/Download_and_install.html">Download and install</a></li><li><a href="../../en/User_documentation/Save_your_first_article.html">Save your first article</a></li><li><a href="../../en/User_documentation/Configure_wallabag.html">Configure wallabag</a></li><li class="active"><a href="../../en/User_documentation/Hidden_options.html">Hidden options</a></li></ul></li></ul>                                                    <div class="well well-sidebar">
 
                                 <!-- Links -->
                                 <a href="https://www.wallabag.org/downloads" target="_blank">Download</a><br><a href="https://github.com/wallabag/wallabag" target="_blank">GitHub Repo</a><br><a href="http://support.wallabag.org" target="_blank">Help</a><br><a href="https://github.com/wallabag/documentation/graphs/contributors" target="_blank">Documentation contributors</a><br>                                
                     <div class="content-page">
                         <article>
                                                             <div class="page-header sub-header clearfix">
-                                    <h1>Hidden options                                                                            </h1>
+                                    <h1>Hidden options                                                                                <a href="https://github.com/wallabag/documentation/blob/master/en/02_User_documentation/14_Hidden_options.md" class="btn">Fix this page</a>                                    </h1>
                                     <span style="float: left; font-size: 10px; color: gray;">
-                                        Monday, November 3, 2014                                    </span>
+                                        Sunday, November 16, 2014                                    </span>
                                     <span style="float: right; font-size: 10px; color: gray;">
-                                        1:28 PM                                    </span>
+                                        9:22 PM                                    </span>
                                 </div>
                             
-                            <p>TODO</p>                                                    </article>
+                            <h2>Be careful</h2>
+<p><strong>Attention</strong>, this part is for advanced users only. We'll edit an important file of wallabag, <code>inc/poche/config.inc.php</code>, please make a backup of this file before changes.<br />
+<strong>If you make a mistake while editing a wallabag file, your application may be broken.</strong></p>
+<p>This file is created when wallabag is installed.<br />
+Please first install wallabag, make a backup of this file and open it with <del>Sublime Text</del> your favorite editor.</p>
+<p>In this file are defined some parameters that you can't change on the wallabag <strong>configuration</strong> page. </p>
+<h2>Advanced options</h2>
+<p>Each parameter is defined like this:</p>
+<pre><code>@define ('PARAMETER_NAME', 'Parameter value');</code></pre>
+<p>For each line, you can only change <code>Parameter value</code> part. </p>
+<p>TODO explain all the following parameters</p>
+<p>Here are all the parameters you can change: </p>
+<ul>
+<li><code>HTTP_PORT</code> (default value is <code>80</code>): Expected value: a digit.</li>
+<li><code>SSL_PORT</code> (default value is <code>443</code>): Expected value: a digit. </li>
+<li><code>DEBUG_POCHE</code> (default value is <code>FALSE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
+<li><code>DOWNLOAD_PICTURES</code> (default value is <code>FALSE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
+<li><code>SHARE_TWITTER</code> (default value is <code>TRUE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
+<li><code>SHARE_MAIL</code> (par défaut, <code>TRUE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
+<li><code>SHARE_SHAARLI</code> (default value is <code>FALSE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
+<li><code>SHAARLI_URL</code> (default value is <code>'http://myshaarliurl.com'</code>): Expected value: your Shaarli URL. </li>
+<li><code>FLATTR</code> (default value is <code>TRUE</code>): Expected values: <code>TRUE</code> or <code>FALSE</code>.</li>
+<li><code>SHOW_PRINTLINK</code> (default value is <code>'1'</code>): Expected values: <code>'0'</code> to disable, <code>'1'</code> to enable.</li>
+<li><code>SHOW_READPERCENT</code> (default value is <code>'1'</code>): <code>'0'</code> to disable, <code>'1'</code> to enable.</li>
+<li><code>PAGINATION</code> (default value is <code>'12'</code>): Expected value: a digit. </li>
+</ul>                            
+                        </article>
                     </div>
                 </div>
             </div>