[[PageOutline]]

= Dictionary Editor and Browser - How to make your own electronic dictionary =

'''Aleš Horák and Adam Rambousek, Faculty of Informatics, Masaryk University, Czech Republic'''

'''European Masters in Language and Speech, 8th Summer School'''

http://nlp.fi.muni.cz/projects/deb2/ [mailto:deb@aurora.fi.muni.cz deb@aurora.fi.muni.cz]


== Introduction ==
 * Dictionary Writing Systems [http://nlp.fi.muni.cz/projekty/deb2/emasters/slides.pdf slides]
  * Papillon [http://www.papillon-dictionary.org/ web], [http://nlp.fi.muni.cz/projekty/deb2/emasters/www/papillon/index.html local]
  * Longman DPS, [http://www.idm.fr/DPSoverview.htm IDM]
  * !TshwaneLex [http://tshwanedje.com/tshwanelex/ web], [http://nlp.fi.muni.cz/projekty/deb2/emasters/www/tshwanelex local]
  * DEB II [http://nlp.fi.muni.cz/projects/deb2/ web]

 * Introduction to XML, [http://www.zvon.org/xxl/XMLTutorial/General/book.html www], [http://nlp.fi.muni.cz/projekty/deb2/emasters/XML/Output/example1.html local]
 * Introduction to XSLT [http://zvon.org/xxl/XSLTutorial/Output/index.html web], [http://nlp.fi.muni.cz/projekty/deb2/emasters/XSL/Output/contents.html local]

== Current DEB projects ==
[http://nlp.fi.muni.cz/projects/deb2/clients/ clients]
 * DEBDict, [http://nlp.fi.muni.cz/projects/deb2/debdict/ web]
 * DEBVisDic, [http://nlp.fi.muni.cz/projects/visualbrowser/ VisualBrowser]
 * PRALED, CPA

How to install client packages - see [http://nlp/trac/deb2/wiki/DebVisDicManual#HowtoinstallDEBVisDic DEBVisDic manual] for info

=== DEBDict ===
 * Install DEBDict
 * Try searching in English or Czech (eg. word pes) dictionaries
 * You may need the dictionaries later for other tasks

=== DEBVisDic ===

[wiki:DebVisDicManual DEBVisDic Manual]
 
 * Install DEBVisDic
 * In ''Preferences'' add "English WN demo"

{{{
#!html
<div style="border: 2px solid blue">
<img src="http://nlp.fi.muni.cz/trac/deb2/chrome/site/task.gif" align="top"> <span style="font-weight: bold; font-size: 115%">Task 1:</span> Add 5-10 new synsets into the Wordnet:
<ul>
<li>under 'domestic animal:1'
<li>under 'predator:2'
<li>under 'planet:1' or 'celestial body:1'
<li>under 'tree:1'
<li>under 'country:1'
</ul>
</div>
}}}

== Dictionary Management ==

Open https://didone.fi.muni.cz:8000/ 

See the brief description of WebAdminInterface

Introduction to Relax NG, [http://relaxng.org/ web], [http://nlp.fi.muni.cz/projekty/deb2/emasters/XSL/Output/contents.html local]


=== Create dictionary ===

* To see the settings for your dictionary, go to ''dictionaries'' and find ''emls[x]''

Dictionary XML schema is preset to:
{{{
#!xml
<element name="entry">
	<element name="headword">
		<text/>
	</element>
	<oneOrMore>
		<element name="def">
			<text/>
		</element>
	</oneOrMore>
	<oneOrMore>
		<element name="synonym" ref="headword">
			<text/>
		</element>
	</oneOrMore>

	<optional>
		<element name="grammar_note">
			<text/>
			<attribute name="pos">
				<text/>
			</attribute>
		</element>
		<element name="pronounce">
			<text/>
		</element>
		<element name="origin">
			<text/>
		</element>
	</optional>
	<element name="author">
		<text/>
	</element>
</element>
}}}

To browse the dictionary or add new entries, you need client software - either Firefox XPI package, or web service.

{{{
#!html
<div style="border: 2px solid blue">
<img src="http://nlp.fi.muni.cz/trac/deb2/chrome/site/task.gif" align="top"> <span style="font-weight: bold; font-size: 115%">Task 2:</span> 
Generate dictionary web service and add five entries
</div>
}}}

 * Go to ''generate web service''
 * Choose your dictionary from the list ''emls[x]''
 * Click ''run'' button
 * Go to https://didone.fi.muni.cz:8001/
 * Click on the link for your dictionary
 * Add five dictionary entries

=== Change dictionary structure ===

{{{
#!html
<div style="border: 2px solid blue">
<img src="http://nlp.fi.muni.cz/trac/deb2/chrome/site/task.gif" align="top"> <span style="font-weight: bold; font-size: 115%">Task 3:</span>
 Change dictionary structure and generate web service again

</div>
}}}

 * PoS could be better as selectbox
 * Go to ''dictionaries''
 * Find ''emlsx'' dictionary
 * Change XML schema. Replace current PoS definition
{{{
#!xml
<attribute name="pos">
    <text/>
</attribute>
}}}
with the new one
{{{
#!xml
<attribute name="pos">
     <choice>
         <value>n</value>
         <value>v</value>
         <value>a</value>
         <value>b</value>
      </choice>
</attribute>
}}}

 * Plus add one new element (for example hypernym or usage example)

 * Go to ''generate web service''
 * Choose your dictionary from the list ''emls[x]''
 * Click ''run'' button
 * Go to https://didone.fi.muni.cz:8001/
 * Click on the link for your dictionary
 * The PoS is changed from textbox to selectbox
 * Add five dictionary entries

=== XSLT changes ===

{{{
#!html
<div style="border: 2px solid blue">
<img src="http://nlp.fi.muni.cz/trac/deb2/chrome/site/task.gif" align="top"> <span style="font-weight: bold; font-size: 115%">Task 4:</span> 
Change the dictionary design by modifying XSLT template
</div>
}}}

You can choose one of the following templates:
 * Entry list (''emls[x]-list.xslt'') - display definition next to headword
 * Entry edit form (''emlsx[x]-edit.xslt'') - change the labels or translate them to your language
 * Entry preview (''emls[x]-preview.xslt'') - design nice preview 
 * Dictionary PDF template (''emls[x]-pdf.xslt'') - advanced, change the look of your PDF file ([http://www.w3schools.com/xslfo/xslfo_reference.asp XSL-FO reference])

Editing the XSLT:
 * Go to the admin interface, and select ''browse - xslt''
 * Open the template file and save it (Ctrl+S in browser)
 * Edit the file
 * Go to the admin interface, and select ''upload''
 * Choose your file and select ''xslt'' from the list, click ''upload''

== Conclusion ==

{{{
#!html
<div style="border: 2px solid blue">
<img src="http://nlp.fi.muni.cz/trac/deb2/chrome/site/task.gif" align="top"> <span style="font-weight: bold; font-size: 115%">Task 5:</span> 
Download XML and PDF for your dictionary
</div>
}}}