forked from bradholland84/Baki-RTT-Old
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tool_description.html
212 lines (190 loc) · 8.33 KB
/
tool_description.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<!--[if IE 6]>
<link href="http://courses.washington.edu/otap/super_design/ie6_ultimate_super.css" type="text/css" rel="stylesheet" media="screen"/>
<![endif]-->
<!--[if !IE 6]><!-->
<link href="http://courses.washington.edu/otap/super_design/ultimate_super.css" type="text/css" rel="stylesheet" media="screen"/>
<!--<![endif]-->
<title>Tool Description</title>
</head>
<body>
<div id="containerGray">
<div id="pageHeader">
<h1>OTAP <br />
Ottoman Text Archive Project</h1>
</div>
</div>
<div id="subBannerGray">
<div id="subHeader">
<h2>Tool Description</h2>
</div>
</div>
<div id="MainGray">
<h3>Description</h3>
<p>
For each of the control buttons on the Reversible Transcription Intake page (e.g., Ottoman Arabic),
there is a php script that is invoked when the button is clicked. The scripts are passed the contents
of the Input Text Area and the contents of the Metadata fields and return the formatted output. These
script files are as follows:
</p>
<blockquote><em>
reverse_ottoman_arabic.php<br/>
reverse_ottoman_latin.php<br/>
reverse_ottoman_turkish.php<br/>
reverse_ottoman_cyrillic.php<br/>
reverse_xml.php
</em></blockquote>
<p>
Each of these scripts works in a very similar fashion. Each loads a file of substitution rules that are
used to perform the transcription. Any tags (e.g., "<italic>") in the input text area are removed and saved
for later reinsertion. This is also true of html entity references (e.g., "#&1576;"). Both of these are removed
so the application of the substitution rules will not mangle them. Incidental whitespace in the input is
simply discarded. The substitution rules are then applied. The rules are in the form:
</p>
<blockquote>
"B7" -> "+1576;", /* Arabic Letter Beh */
</blockquote>
<p>
In this example, a "B7" in the input will be replaced by "+1576;" which is an entity reference for the
Arabic Letter Beh. The "+" will be replaced by "#&" right before the final output. "*" and "**" are used to
mark line breaks and line group breaks respectively. Line breaks are done with div tags and line groups
have a p tag surrounding the groups of lines, each with its own div tag. The code in each script
is commented if more detail is needed about its specific operation.
</p>
<p>
In the file of substitution rules, the rules are listed in the order they will be applied, separated by commas. Anything between "/*" and "*/" is a comment and can used to add documentation. Each part of the rule is in quotes so that white space in the input can be interpreted correctly as needed. These are two distinct substitution rules:
</p>
<blockquote>
" B7" -> " +1576;",<br/>
"B7" -> "+1576;",
</blockquote>
<p>
The rules are applied in the order they appear in the rules file. When adding rules, one must consider where
to order them in the list. In the two rules shown above, applying the rule without the space first would almost
certainly prevent the one with the space from ever being applied.
</p>
<p>
The rules files are as follows:
</p>
<blockquote><em>
ottoman_arabic_rules.txt<br/>
ottoman_cyrillic_rules.txt<br/>
ottoman_latin_rules.txt<br/>
ottoman_turkish_rules.txt
</em></blockquote>
<p>
The XML php script uses the same rules file as the Ottoman Arabic. There is also a set of rules in the file
"dynamic_chart_rules.txt". This is used to dynamically generate a table of all the substitution rules with a
brief descriptive note. This chart is intended primarily for debugging purposes for the person modifying or
adding rules to the transcription rules files.
</p>
<h3>Functional Files</h3>
<p>
A complete list of the functional files (with a descriptive note) is as follows:
</p>
<blockquote>
<em>reverse_tool_intake.html</em><br/>
The intake page where text is entered to get a reverse transcription.
</blockquote>
<p>
<b>PHP scripts:</b>
</p>
<blockquote>
<em>reverse_ottoman_arabic.php</em><br/>
Script to return Ottoman Arabic.<br/>
<em>reverse_ottoman_latin.php</em><br/>
Script to return Ottoman Latin.<br/>
<em>reverse_ottoman_turkish.php</em><br/>
Script to return Turkish.<br/>
<em>reverse_ottoman_cyrillic.php</em><br/>
Script to return the Cyrillic output. This currently in development.<br/>
<em>reverse_xml.php</em><br/>
Script to return XML. This currently in development.<br/>
<em>functions.php</em><br/>
Has a couple of auxiliary functions that are used in common by all the scripts<br/>
for reading in the rules files.
</blockquote>
<p>
<b>Substitution Rules text files:</b>
</p>
<blockquote><em>
ottoman_arabic_rules.txt<br/>
ottoman_cyrillic_rules.txt<br/>
ottoman_latin_rules.txt<br/>
ottoman_turkish_rules.txt<br/>
dynamic_chart_rules.txt
</em></blockquote>
<p>
These are very minimal stylesheets:
</p>
<blockquote><em>
style_arabic.css<br/>
style_cyrillic.css<br/>
style_latin.css<br/>
style_turkish.css
</em></blockquote>
<h3>Site Map</h3>
<small>
<div><b> http://courses.washington.edu/otap/reverse/reverse.html</b></div>
First page of the Reverse Transcription Tool featuring a project description and a link to an article about reverse transcription.
<blockquote>
<div><b>http://courses.washington.edu/otap/reverse/reverse/o_Reverse_trans_article728.html</b></div>
The above mentioned article.
<div><b>http://courses.washington.edu/otap/reverse/intake/reverse_tool.html</b></div>
Page with the following links for more information and link to the tool itself.
<blockquote>
<div><b>http://courses.washington.edu/otap/reverse/intake/getting_started.html</b></div>
Instructions for using the reverse transcription tool.
<div><b>http://courses.washington.edu/otap/reverse/intake/consonants_eng.html</b></div>
Chart of consonant conversions in English order.
<div><b>http://courses.washington.edu/otap/reverse/intake/consonants_arb.html</b></div>
Chart of consonant conversions in Arabic order.
<div><b>http://courses.washington.edu/otap/reverse/intake/vowels.html</b></div>
Chart of vowel conversion codes.
<div><b>http://courses.washington.edu/otap/reverse/intake/special_characters.html</b></div>
Chart of special character codes.
<div><b>http://courses.washington.edu/otap/reverse/intake/conversion_chart.php</b></div>
Dynamically generated chart that displays all of the substitution rules.
<div><b>http://courses.washington.edu/otap/reverse/intake/writing_arabic.html</b></div>
Incomplete article.
<div><b>http://courses.washington.edu/otap/reverse/intake/reverse_tool_intake.html</b></div>
The intake page where text is entered to get a reverse transcription.
<blockquote>
<div><b>http://courses.washington.edu/otap/reverse/intake/reverse_ottoman_arabic.php</b></div>
Script to return Ottoman Arabic. Run this by clicking on the Ottoman Arabic button.
<div><b>http://courses.washington.edu/otap/reverse/intake/reverse_ottoman_latin.php</b></div>
Script to return Ottoman Latin. Run this by clicking on the Ottoman Latin button.
<div><b>http://courses.washington.edu/otap/reverse/intake/reverse_ottoman_turkish.php</b></div>
Script to return Turkish. Run this by clicking on the Turkish button.
<div><b>http://courses.washington.edu/otap/reverse/intake/reverse_ottoman_cyrillic.php</b></div>
Script to return the Other output. This currently in development.
<div><b>http://courses.washington.edu/otap/reverse/intake/reverse_xml.php</b></div>
Script to return XML. This currently in development.
</blockquote>
</blockquote>
</blockquote>
</small>
</div>
<div id="footerGray">
<div id="subFooter">
<h4>Send email to: [email protected]</h4>
</div>
</div>
<div id="extraFooter">
<img src="/otap/super_design/filler.jpg" alt="" />
</div>
<div id="disclaimerGray">
<div id="disclaimer">
<h4>Disclaimer</h4>
<p>Non-commerical use of files on this site is allowed with attribution, all other uses are prohibited. <br />Accepting these restrictions is a condition of entering the website.</p>
</div>
</div>
<div id="homeLink">
<p class="homeP"><a id="homeA" href="http://courses.washington.edu/otap/index.html">Back to home</a></p>
</div>
</body>
</html>