Skip to content

Commit 9eadca5

Browse files
committed
Updated documentation.
1 parent a5e638d commit 9eadca5

17 files changed

Lines changed: 524 additions & 399 deletions

‎docs/html/do__feeds_8php.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,25 +82,25 @@
8282
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
8383
Variables</h2></td></tr>
8484
<tr class="memitem:a5aa4fc1f2b62bde86af501cedb7707c8"><td class="memItemLeft" align="right" valign="top"><a id="a5aa4fc1f2b62bde86af501cedb7707c8" name="a5aa4fc1f2b62bde86af501cedb7707c8"></a>
85-
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentlang</b> = <a class="el" href="database__connect_8php.html#a02d40918dc384387272eb42f065925c6">validateLang</a>(processDBParam(&quot;filterlang&quot;, 'currentlanguage', '', 0))</td></tr>
85+
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentlang</b> = <a class="el" href="database__connect_8php.html#a02d40918dc384387272eb42f065925c6">validateLang</a>(<a class="el" href="session__utility_8php.html#abbe995764b8c9ba1e0d77061ec9c9f3d">processDBParam</a>(&quot;filterlang&quot;, 'currentlanguage', '', 0))</td></tr>
8686
<tr class="separator:a5aa4fc1f2b62bde86af501cedb7707c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
8787
<tr class="memitem:a592001c6b0a088ee3768be629bc3ae17"><td class="memItemLeft" align="right" valign="top"><a id="a592001c6b0a088ee3768be629bc3ae17" name="a592001c6b0a088ee3768be629bc3ae17"></a>
88-
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentsort</b> = processDBParam(&quot;sort&quot;, 'currentrsssort', '2', 1)</td></tr>
88+
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentsort</b> = <a class="el" href="session__utility_8php.html#abbe995764b8c9ba1e0d77061ec9c9f3d">processDBParam</a>(&quot;sort&quot;, 'currentrsssort', '2', 1)</td></tr>
8989
<tr class="separator:a592001c6b0a088ee3768be629bc3ae17"><td class="memSeparator" colspan="2">&#160;</td></tr>
9090
<tr class="memitem:a04318951a009e0355d0df46ad512fd75"><td class="memItemLeft" align="right" valign="top"><a id="a04318951a009e0355d0df46ad512fd75" name="a04318951a009e0355d0df46ad512fd75"></a>
91-
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentquery</b> = processSessParam(&quot;query&quot;, &quot;currentrssquery&quot;, '', 0)</td></tr>
91+
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentquery</b> = <a class="el" href="session__utility_8php.html#a448c3c3758664ea191b594625646cc5c">processSessParam</a>(&quot;query&quot;, &quot;currentrssquery&quot;, '', 0)</td></tr>
9292
<tr class="separator:a04318951a009e0355d0df46ad512fd75"><td class="memSeparator" colspan="2">&#160;</td></tr>
9393
<tr class="memitem:a0c7c3b6ef879756cb217336efab71878"><td class="memItemLeft" align="right" valign="top"><a id="a0c7c3b6ef879756cb217336efab71878" name="a0c7c3b6ef879756cb217336efab71878"></a>
94-
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentquerymode</b> = processSessParam(&quot;query_mode&quot;, &quot;currentrssquerymode&quot;, 'title,desc,text', 0)</td></tr>
94+
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentquerymode</b> = <a class="el" href="session__utility_8php.html#a448c3c3758664ea191b594625646cc5c">processSessParam</a>(&quot;query_mode&quot;, &quot;currentrssquerymode&quot;, 'title,desc,text', 0)</td></tr>
9595
<tr class="separator:a0c7c3b6ef879756cb217336efab71878"><td class="memSeparator" colspan="2">&#160;</td></tr>
9696
<tr class="memitem:a54d99d8b400d86d0e61d2b9dbb6748f1"><td class="memItemLeft" align="right" valign="top"><a id="a54d99d8b400d86d0e61d2b9dbb6748f1" name="a54d99d8b400d86d0e61d2b9dbb6748f1"></a>
9797
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentregexmode</b> = <a class="el" href="database__connect_8php.html#a272e6920bd0ac3690730a62edebae42d">getSettingWithDefault</a>(&quot;set-regex-mode&quot;)</td></tr>
9898
<tr class="separator:a54d99d8b400d86d0e61d2b9dbb6748f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
9999
<tr class="memitem:a2cf6eb6f2c4d1e6204209a5341ccb537"><td class="memItemLeft" align="right" valign="top"><a id="a2cf6eb6f2c4d1e6204209a5341ccb537" name="a2cf6eb6f2c4d1e6204209a5341ccb537"></a>
100-
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentpage</b> = processSessParam(&quot;page&quot;, &quot;currentrsspage&quot;, '1', 1)</td></tr>
100+
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentpage</b> = <a class="el" href="session__utility_8php.html#a448c3c3758664ea191b594625646cc5c">processSessParam</a>(&quot;page&quot;, &quot;currentrsspage&quot;, '1', 1)</td></tr>
101101
<tr class="separator:a2cf6eb6f2c4d1e6204209a5341ccb537"><td class="memSeparator" colspan="2">&#160;</td></tr>
102102
<tr class="memitem:a34aac2e40713ef51c74704bc2110e15b"><td class="memItemLeft" align="right" valign="top"><a id="a34aac2e40713ef51c74704bc2110e15b" name="a34aac2e40713ef51c74704bc2110e15b"></a>
103-
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentfeed</b> = processSessParam(&quot;selected_feed&quot;, &quot;currentrssfeed&quot;, '', 0)</td></tr>
103+
&#160;</td><td class="memItemRight" valign="bottom"><b>$currentfeed</b> = <a class="el" href="session__utility_8php.html#a448c3c3758664ea191b594625646cc5c">processSessParam</a>(&quot;selected_feed&quot;, &quot;currentrssfeed&quot;, '', 0)</td></tr>
104104
<tr class="separator:a34aac2e40713ef51c74704bc2110e15b"><td class="memSeparator" colspan="2">&#160;</td></tr>
105105
<tr class="memitem:adfceb82dc7f82e957c5fae24b1dcb71c"><td class="memItemLeft" align="right" valign="top"><a id="adfceb82dc7f82e957c5fae24b1dcb71c" name="adfceb82dc7f82e957c5fae24b1dcb71c"></a>
106106
&#160;</td><td class="memItemRight" valign="bottom"><b>$wh_query</b> = $currentregexmode . 'like ' . <a class="el" href="database__connect_8php.html#a8644cebbae39e02a6dfed79816201271">convert_string_to_sqlsyntax</a>(($currentregexmode == '') ? (str_replace(&quot;*&quot;, &quot;%&quot;, mb_strtolower($currentquery, 'UTF-8'))) : ($currentquery))</td></tr>

‎docs/html/edit__texts_8php.html‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -261,13 +261,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4a91f2652a2a62229af02d57
261261
<dl class="params"><dt>Parameters</dt><dd>
262262
<table class="params">
263263
<tr><td class="paramtype">string</td><td class="paramname">$op</td><td>Operation name </td></tr>
264-
<tr><td class="paramtype">string</td><td class="paramname">$message1</td><td>Number of texts edited </td></tr>
264+
<tr><td class="paramtype">string</td><td class="paramname">$message1</td><td>Unnused </td></tr>
265265
<tr><td class="paramtype">int</td><td class="paramname">$no_pagestart</td><td>If you don't want a page</td></tr>
266266
</table>
267267
</dd>
268268
</dl>
269269
<dl class="section return"><dt>Returns</dt><dd>string Edition message (number of rows edited)</dd></dl>
270-
<p>@global string $tbpref Database table prefix </p>
270+
<p>@global string $tbpref Database table prefix</p>
271+
<dl class="section since"><dt>Since</dt><dd>2.4.1-fork $message1 is unnused </dd></dl>
271272

272273
</div>
273274
</div>
@@ -445,14 +446,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab859d1e74d3f9800704a8fbc
445446
<p >When a mark action is in use, do the action.</p>
446447
<dl class="params"><dt>Parameters</dt><dd>
447448
<table class="params">
448-
<tr><td class="paramtype">string</td><td class="paramname">$maraction</td><td>Type of action </td></tr>
449+
<tr><td class="paramtype">string</td><td class="paramname">$markaction</td><td>Type of action </td></tr>
449450
<tr><td class="paramtype">array</td><td class="paramname">$marked</td><td>Texts marked. </td></tr>
450451
<tr><td class="paramtype">string</td><td class="paramname">$actiondata</td><td>Values to insert to the database</td></tr>
451452
</table>
452453
</dd>
453454
</dl>
454-
<dl class="section return"><dt>Returns</dt><dd>string[2] Massage and number of rows edited.</dd></dl>
455-
<p>@global string $tbpref Database table prefix </p>
455+
<dl class="section return"><dt>Returns</dt><dd>string[2] Number of rows edited, the second string is always null.</dd></dl>
456+
<p>@global string $tbpref Database table prefix</p>
457+
<dl class="section since"><dt>Since</dt><dd>2.4.1-fork The second return field is always null </dd></dl>
456458

457459
</div>
458460
</div>
@@ -594,7 +596,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac5850389e2199335d4db3996
594596
<dl class="params"><dt>Parameters</dt><dd>
595597
<table class="params">
596598
<tr><td class="paramtype">string</td><td class="paramname">$currentlang</td><td>Current language ID </td></tr>
597-
<tr><td class="paramtype">int</td><td class="paramname">$showCounts</td><td>Number of items to show </td></tr>
599+
<tr><td class="paramtype">string</td><td class="paramname">$showCounts</td><td>Number of items to show, put into a string </td></tr>
598600
<tr><td class="paramtype">string</td><td class="paramname">$sql</td><td>SQL string to execute </td></tr>
599601
<tr><td class="paramtype">int</td><td class="paramname">$recno</td><td>Record number</td></tr>
600602
</table>

‎docs/html/globals_func_p.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ <h3><a id="index_p" name="index_p"></a>- p -</h3><ul>
8080
<li>print_file_path()&#160;:&#160;<a class="el" href="session__utility_8php.html#a0caab76499b93b3291b2c8b2490ea3da">session_utility.php</a></li>
8181
<li>print_similar_terms()&#160;:&#160;<a class="el" href="simterms_8php.html#ae757838966b3688392e9ed28f6721a37">simterms.php</a></li>
8282
<li>print_term_test()&#160;:&#160;<a class="el" href="do__test__test_8php.html#aa4dcc9f7101f95be23101b1faa93f777">do_test_test.php</a></li>
83+
<li>processDBParam()&#160;:&#160;<a class="el" href="session__utility_8php.html#abbe995764b8c9ba1e0d77061ec9c9f3d">session_utility.php</a></li>
84+
<li>processSessParam()&#160;:&#160;<a class="el" href="session__utility_8php.html#a448c3c3758664ea191b594625646cc5c">session_utility.php</a></li>
8385
</ul>
8486
</div><!-- contents -->
8587
<!-- start footer part -->

‎docs/html/globals_p.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,8 @@ <h3><a id="index_p" name="index_p"></a>- p -</h3><ul>
8080
<li>print_file_path()&#160;:&#160;<a class="el" href="session__utility_8php.html#a0caab76499b93b3291b2c8b2490ea3da">session_utility.php</a></li>
8181
<li>print_similar_terms()&#160;:&#160;<a class="el" href="simterms_8php.html#ae757838966b3688392e9ed28f6721a37">simterms.php</a></li>
8282
<li>print_term_test()&#160;:&#160;<a class="el" href="do__test__test_8php.html#aa4dcc9f7101f95be23101b1faa93f777">do_test_test.php</a></li>
83+
<li>processDBParam()&#160;:&#160;<a class="el" href="session__utility_8php.html#abbe995764b8c9ba1e0d77061ec9c9f3d">session_utility.php</a></li>
84+
<li>processSessParam()&#160;:&#160;<a class="el" href="session__utility_8php.html#a448c3c3758664ea191b594625646cc5c">session_utility.php</a></li>
8385
</ul>
8486
</div><!-- contents -->
8587
<!-- start footer part -->

‎docs/html/index.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
<p ><b>Learning with Texts</b> (LWT) is a tool for language learning by reading. It is a self-hosted web application.</p>
7272
<p >You feel that you won't learn much by translating dumb sentences or using grammar books? Learning with Texts offers you the possibility to learn by reading texts in your objective language. The idea: when you don't know a word in a text, just click it. We show you the translation, and you will have regular tests to remember it. Ready to go?</p>
7373
<p ><b>THIS IS A THIRD PARTY VERSION</b>. This version is not the official one, and brings many improvements and new featuress. It is quicker, has smaller databse size, and is open for contributions. The official version is on <a href="https://sourceforge.net/projects/learning-with-texts">source forge</a></p>
74-
<h1><a class="anchor" id="autotoc_md388"></a>
74+
<h1><a class="anchor" id="autotoc_md391"></a>
7575
Installation</h1>
7676
<p >As it is self-hosted, you will need a server, which can be your computer.</p>
7777
<ul>
@@ -84,7 +84,7 @@ <h1><a class="anchor" id="autotoc_md388"></a>
8484
</ul>
8585
<p >And you are ready to go!</p>
8686
<p >Please note that a composer repo is available, as well as an installation using Docker.</p>
87-
<h1><a class="anchor" id="autotoc_md389"></a>
87+
<h1><a class="anchor" id="autotoc_md392"></a>
8888
Description</h1>
8989
<p >LWT is a language learning web application. To learn a language, you need to practice, and we guide you in reading exercices.</p>
9090
<p >First copy/paste any text you want to read. It can be raw text or an RSS feed.</p>
@@ -95,7 +95,7 @@ <h1><a class="anchor" id="autotoc_md389"></a>
9595
<p >To make sure you memorize new words, you can take review exercises.</p>
9696
<p ><img src="https://github.com/HugoFara/lwt/raw/master/img/07.jpg" alt="Reviewing French word" class="inline"/></p>
9797
<p >The difference with popular remembering software like <a href="https://apps.ankiweb.net/">Anki</a> is that we keep track of the context to help you. By the way, we also ship an Anki exporter.</p>
98-
<h1><a class="anchor" id="autotoc_md390"></a>
98+
<h1><a class="anchor" id="autotoc_md393"></a>
9999
Features</h1>
100100
<ul>
101101
<li><b>Full list</b>: <a class="el" href="md_docs_features.html">docs/features.md</a></li>
@@ -108,7 +108,7 @@ <h1><a class="anchor" id="autotoc_md390"></a>
108108
<li>Practice words you don't remember</li>
109109
<li>Statistics to record your progress</li>
110110
</ul>
111-
<h2><a class="anchor" id="autotoc_md391"></a>
111+
<h2><a class="anchor" id="autotoc_md394"></a>
112112
Features not in the official LWT</h2>
113113
<ul>
114114
<li><b>Full list</b>: <a class="el" href="md_docs_newfeatures.html">docs/newfeatures.md</a></li>
@@ -126,7 +126,7 @@ <h2><a class="anchor" id="autotoc_md391"></a>
126126
<li>Selecting terms according to a text tag</li>
127127
<li>Two database backup modes (new or old structure)</li>
128128
</ul>
129-
<h2><a class="anchor" id="autotoc_md392"></a>
129+
<h2><a class="anchor" id="autotoc_md395"></a>
130130
Improvements compared to the official LWT</h2>
131131
<ul>
132132
<li>Database improvements (db size is much smaller now)</li>
@@ -139,7 +139,7 @@ <h2><a class="anchor" id="autotoc_md392"></a>
139139
<li>Code documentation.</li>
140140
<li>Code is well organised, making debugging and contribution easier.</li>
141141
</ul>
142-
<h1><a class="anchor" id="autotoc_md393"></a>
142+
<h1><a class="anchor" id="autotoc_md396"></a>
143143
Contribute</h1>
144144
<ul>
145145
<li><b>Complete explanation</b>: <a class="el" href="md_docs_contribute.html">docs/contribute.md</a></li>
@@ -150,28 +150,28 @@ <h1><a class="anchor" id="autotoc_md393"></a>
150150
<p >In short: </p><div class="fragment"><div class="line">git clone https://github.com/HugoFara/lwt</div>
151151
<div class="line">cd lwt</div>
152152
<div class="line">composer install --dev</div>
153-
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md394"></a>
153+
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md397"></a>
154154
Branches</h1>
155155
<ul>
156156
<li>The stable branch is <em>master</em>. Last commit on this branch is considered to be bug-free.</li>
157157
<li>The <em>dev</em> branch is for unstable versions.</li>
158158
<li>The <em>official</em> branch is for the official LWT Releases. Any other branch if considered under development.</li>
159159
</ul>
160-
<h1><a class="anchor" id="autotoc_md395"></a>
160+
<h1><a class="anchor" id="autotoc_md398"></a>
161161
Useful links</h1>
162162
<ul>
163163
<li>General documentation at <a href="https://hugofara.github.io/lwt/docs/info.html">docs/info.html</a>.</li>
164164
<li>Please find more help at <a href="https://hugofara.github.io/lwt/docs/index.html">docs/index.html</a>.</li>
165165
<li>You can also contact the community by GitHub.</li>
166166
</ul>
167-
<h1><a class="anchor" id="autotoc_md396"></a>
167+
<h1><a class="anchor" id="autotoc_md399"></a>
168168
Alternatives</h1>
169169
<ul>
170170
<li><em>See also</em>: <a class="el" href="md_docs_links.html">docs/links.md</a> LWT is written for web, but you have many choices if you want a standalone installation:</li>
171171
<li><a href="https://github.com/gustavklopp/LingL">LingL</a> is a wonderful alternative written in Python, by <a href="https://github.com/gustavklopp">gustavklopp</a>.</li>
172172
<li><a href="https://sourceforge.net/projects/foreign-language-text-reader/">FLTR ◆ Foreign Language Text Reader</a>, a Java clone, by the same author as LWT (<a href="https://sourceforge.net/u/lang-learn-guy/profile/">lang-learn-guy</a>)</li>
173173
</ul>
174-
<h1><a class="anchor" id="autotoc_md397"></a>
174+
<h1><a class="anchor" id="autotoc_md400"></a>
175175
Unlicense</h1>
176176
<p >Under unlicense, view <a class="el" href="md__u_n_l_i_c_e_n_s_e.html">UNLICENSE.md</a>, please refer to [<a href="http://unlicense.org/">http://unlicense.org/</a>].</p>
177177
<p ><b>Let's learn new languages!</b> </p>

0 commit comments

Comments
 (0)