Repository navigation
Expand file tree
/
Copy pathdisplay__impr__text__text_8php.html
More file actions
323 lines (306 loc) · 14.6 KB
/
Copy pathdisplay__impr__text__text_8php.html
File metadata and controls
323 lines (306 loc) · 14.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Learning with Texts - Fork: display_impr_text_text.php File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="lwt_icon.png"/></td>
<td id="projectalign">
<div id="projectname">Learning with Texts - Fork<span id="projectnumber"> 2.8.1-fork</span>
</div>
<div id="projectbrief">Learn foreign languages with texts</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">display_impr_text_text.php File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Display an improved annotated text (text frame)
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespace_lwt"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lwt.html">Lwt</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a05b758959acd517537b63944237b7b92"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="display__impr__text__text_8php.html#a05b758959acd517537b63944237b7b92">get_annotated_text</a> ($textid)</td></tr>
<tr class="separator:a05b758959acd517537b63944237b7b92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd7f07275fffa12df4a54d9d09c37bc7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="display__impr__text__text_8php.html#acd7f07275fffa12df4a54d9d09c37bc7">get_display_impr_text_text_data</a> ($textid)</td></tr>
<tr class="separator:acd7f07275fffa12df4a54d9d09c37bc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef765a226cb9364660b93b2f1ac0782d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="display__impr__text__text_8php.html#aef765a226cb9364660b93b2f1ac0782d">do_diplay_impr_text_text_js</a> ()</td></tr>
<tr class="separator:aef765a226cb9364660b93b2f1ac0782d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af03a61ba63e671e3cddbb5143f58f191"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="display__impr__text__text_8php.html#af03a61ba63e671e3cddbb5143f58f191">do_diplay_impr_text_text_area</a> ($ann, $textsize, $rtlScript)</td></tr>
<tr class="separator:af03a61ba63e671e3cddbb5143f58f191"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43fea397bc1d4f91dfebdc497f114671"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="display__impr__text__text_8php.html#a43fea397bc1d4f91dfebdc497f114671">get_word_annotations</a> ($vals)</td></tr>
<tr class="separator:a43fea397bc1d4f91dfebdc497f114671"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa376fb38f307fc28b8c682850a503610"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="display__impr__text__text_8php.html#aa376fb38f307fc28b8c682850a503610">do_display_impr_text_text_word</a> ($item, $textsize)</td></tr>
<tr class="separator:aa376fb38f307fc28b8c682850a503610"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a61c2bf8e6fc3aea67c1c3dbda02f89"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="display__impr__text__text_8php.html#a7a61c2bf8e6fc3aea67c1c3dbda02f89">do_display_impr_text_text_main</a> ($textid=null)</td></tr>
<tr class="separator:a7a61c2bf8e6fc3aea67c1c3dbda02f89"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Display an improved annotated text (text frame) </p>
<p>Call: <a class="el" href="display__impr__text__text_8php.html" title="Display an improved annotated text (text frame)">display_impr_text_text.php</a>?text=[textid] </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="af03a61ba63e671e3cddbb5143f58f191" name="af03a61ba63e671e3cddbb5143f58f191"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af03a61ba63e671e3cddbb5143f58f191">◆ </a></span>do_diplay_impr_text_text_area()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">do_diplay_impr_text_text_area </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$ann</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$textsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$rtlScript</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make the main content for a printed text.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$ann</td><td>Annotations separated b tabulations "\t" </td></tr>
<tr><td class="paramtype">string</td><td class="paramname">$textsize</td><td>Text size </td></tr>
<tr><td class="paramtype">bool</td><td class="paramname">$rtlScript</td><td>True if this text is right-to-left</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
</div>
</div>
<a id="aef765a226cb9364660b93b2f1ac0782d" name="aef765a226cb9364660b93b2f1ac0782d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef765a226cb9364660b93b2f1ac0782d">◆ </a></span>do_diplay_impr_text_text_js()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">do_diplay_impr_text_text_js </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare JavaScript interactions for the text content.</p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<p>When user clicks an annotation.</p>
<p>When user clicks the text.</p>
</div>
</div>
<a id="a7a61c2bf8e6fc3aea67c1c3dbda02f89" name="a7a61c2bf8e6fc3aea67c1c3dbda02f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a61c2bf8e6fc3aea67c1c3dbda02f89">◆ </a></span>do_display_impr_text_text_main()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">do_display_impr_text_text_main </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$textid</em> = <code>null</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Main function to do a complete printed text text content.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">int | null</td><td class="paramname">$textid</td><td>Text ID, we will use page request if not provided.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
</div>
</div>
<a id="aa376fb38f307fc28b8c682850a503610" name="aa376fb38f307fc28b8c682850a503610"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa376fb38f307fc28b8c682850a503610">◆ </a></span>do_display_impr_text_text_word()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">do_display_impr_text_text_word </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$textsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Display a single word item.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">string</td><td class="paramname">$item</td><td>Word item, values separated by a tabulation. </td></tr>
<tr><td class="paramtype">string</td><td class="paramname">$textsize</td><td>Text size</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
</div>
</div>
<a id="a05b758959acd517537b63944237b7b92" name="a05b758959acd517537b63944237b7b92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05b758959acd517537b63944237b7b92">◆ </a></span>get_annotated_text()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">get_annotated_text </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$textid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the annotatino of a text.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">int</td><td class="paramname">$textid</td><td>Text ID</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>string Text annotations </dd></dl>
</div>
</div>
<a id="acd7f07275fffa12df4a54d9d09c37bc7" name="acd7f07275fffa12df4a54d9d09c37bc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd7f07275fffa12df4a54d9d09c37bc7">◆ </a></span>get_display_impr_text_text_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">get_display_impr_text_text_data </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$textid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get settings for this text.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">int</td><td class="paramname">$textid</td><td>Text ID</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>array{0: string, 1: string} Text size, and if this text is rigth-to-left. </dd></dl>
</div>
</div>
<a id="a43fea397bc1d4f91dfebdc497f114671" name="a43fea397bc1d4f91dfebdc497f114671"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43fea397bc1d4f91dfebdc497f114671">◆ </a></span>get_word_annotations()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">get_word_annotations </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$vals</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse the annotations (translation/romanization) and return them.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramtype">string[]</td><td class="paramname">$vals</td><td>Annotations values</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>array{0: string, 1: string} Translation and romanization.</dd></dl>
<p>@global string $tbpref Database table prefix. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>