This page contains instructions for how to use the dictionary uploader, and how to format your document for the best results.
Before we go into lots of detail, here's a working example:
\lx birndu
\ps n.
\sf birndu.mp3
\vi https://youtu.be/hjz-buIlk2c
\sn 1
\re mosquito
\de Mosquito. There is a fv:djang totemic site for the mosquito near Marrkolidjban.
\xv Bu Kudjewk wanjh birringimi kuwarderurrk birriyoy dja mandjewk dja birndu.
\xe In the wet season they moved into caves to stay, because of the rain and mosquitos.
\so Nabulanj Namandjulngunj, Injalak Arts painting documentation
\pdn kk=mernengel
\sd insects
\sn 2
\re march fly
\de March fly.
\sd insects
\sn 3
\re glossy ibis
\de Glossy ibis (which is black and has a beak like a mosquito proboscis thus the polysemy).
\xv Ngalbu birndu ngalkka mayhmayh karrinan kore kabbal bu kudjewk dja kurrung karrolkarren karrinan mirndewern.
\xe We see glossy ibis on the floodplain in the wet season, and we see lots of them flying in the build-up season.
\so Nabulanj Namandjulngunj, Injalak Arts painting documentation
\sc Plegadis falcinellis
\sd birds
\sd language_course_unit_5
\dm 14/Oct/2018
You can add 'about' sections at the top of the dictionary text file. Use the code \xvd, followed by the heading you'd like, then two colons like so:
\xvd Welcome:: Welcome to Gijingarliya Wengga, a dictionary of Burarra and Gun-nartpa.
\xvd What's new?:: Added 100 new words.
These sections will display in an 'About' tab on the left hand side, and the first one will display in full to the right of the entries in desktop view. You can use markdown in these sections, so you can add **bold** or *italics* or [links](https://example.com) or whatever you like.
Headword audio can be added by adding an \sf (sound file) field to the entry, ideally somewhere near the top (say under the \ps, somewhere around there is good). Example sentence audio can be added with an \sfx field (under the \xv or under the \xe). Mp3 is the preferred format, some others may work but I'm not sure. Files in .wav format can be used but they are very large and not ideal for web use.
\sfx ngudda_kamak-jill_nganjmirra.mp3 There's no need to add the file path,
just the filename.
Similar to audio, images can be added by adding a \pc (picture) field to the entry, somewhere near the top of the entry is good. You can also add images to senses, if you nest the \pc field under an \sn field.
\pc kunj.jpg. It's best not to use spaces or capital letters in the filename if
you can help it - it still works but it can more easily lead to mistakes and issues. There's
no need to add the file path, just the filename. Supported formats are JPEG and PNG. Be
aware that the spelling and case of the extension should match, i.e. .jpg ≠ .JPG, and .jpg ≠
.jpeg, so if you can, just make everything .jpg for sanity. On Mac at least you can select a
whole lot of files, then right click and select "Rename" to rename them all at once. You can
also add other fields like a source and anchor (link) to the source, see:
Image.
This guide describes all the fields and structures available for dictionary entries.
Some fields automatically start a new section when they appear. These are:
\lx (Lexeme), it starts a new Entry\sn (Sense Number), it starts a new Sense section\xv (Example Vernacular), it starts a new Example sentence section\se (Sub Entry Vernacular), it starts a new Sub-entry section\cf (Cross Reference Vernacular), it starts a new See also section\pdl (Paradigm Label), it starts a new Paradigm section\pd (Paradigm Set), it starts a new Paradigm list section\pdr (Paradigm Regional), it starts a new Paradigm item section\sd (Semantic Domain), it starts a new Semantic domain (category) section\pc (Picture), it starts a new Image section\sf (Headword Sound), it starts a new Headword audio section\vi (Video), it starts a new Video section\sfx (Example Sentence Audio), it starts a new Example sentence audio section\sdx (Example Sentence Semantic Domain), it starts a new Semantic domain of example sentence sectionHere are all the simple fields that can be used in entries:
\an: Antonym\bw: Borrowing\ce: Cross Reference English\cf: Cross Reference Vernacular\cm: Comment\de: Definition English\dt: Date Stamp\ee: Encyclopedic Information English\ge: Gloss English\hy: Hypernym\lx: Lexeme\lxn: Lexeme Number\mn: Main Entry\mt: Morphological Template\ng: Grammar Note\ns: Entry Notes\nt: Notes General\ol: In Other Languages\or: In Other Registers\pc: Picture\pd: Paradigm Set\pdl: Paradigm Label\pdn: Paradigm Name\pdr: Paradigm Regional\pdv: Paradigm Vernacular\ps: Part Of Speech\re: Reverse English\rf: Reference For Example\sa: Source Anchor\sc: Scientific Name\sd: Semantic Domain\sdx: Example Sentence Semantic Domain\se: Sub Entry Vernacular\sf: Headword Sound\sfx: Example Sentence Audio\sl: Source License\sn: Sense Number\so: Source\sy: Synonym\ue: Usage English\ur: In Other Dialects\uv: Dialect\va: Variant Form\vi: Video\vr: Variant Regional\xe: Example English\xv: Example VernacularThese are the complex structures that can contain multiple fields:
The main dictionary entry. This is the top-level structure for each lexeme.
Simple fields:
\lx) - Required, single value\lxn) - Optional, single value\va) - Optional, multiple allowed\vr) - Optional, multiple allowed\ps) - Optional, single value\mt) - Optional, single value\ge) - Optional, single value\ns) - Optional, single value\re) - Optional, multiple allowed\ng) - Optional, single value\de) - Optional, single value\sc) - Optional, single value\mn) - Optional, single value\ee) - Optional, multiple allowed\so) - Optional, single value\cm) - Optional, multiple allowed\uv) - Optional, single value\an) - Optional, single value\ur) - Optional, single value\ol) - Optional, single value\or) - Optional, single value\bw) - Optional, single value\dt) - Optional, single value\ue) - Optional, multiple allowed\hy) - Optional, single valueComposed fields:
A distinct meaning or sense of a lexeme. Use \sn to start a new sense.
Simple fields:
\sn) - Required, single value\ps) - Optional, single value\ge) - Optional, single value\re) - Optional, multiple allowed\de) - Optional, single value\ng) - Optional, single value\nt) - Optional, multiple allowed\sy) - Optional, single value\hy) - Optional, single value\an) - Optional, single value\ue) - Optional, multiple allowed\cm) - Optional, multiple allowed\ee) - Optional, multiple allowed\sc) - Optional, single valueComposed fields:
An example sentence or phrase. Use \xv to start a new phrase.
Simple fields:
\xv) - Required, single value\xe) - Optional, single value\so) - Optional, single value\ng) - Optional, single value\cm) - Optional, multiple allowed\rf) - Optional, single valueComposed fields:
A sub-entry or derivative form. Use \se to start a new sub-entry.
Simple fields:
\se) - Required, single value\ge) - Optional, single value\re) - Optional, multiple allowed\mt) - Optional, single value\ee) - Optional, multiple allowed\ps) - Optional, single value\de) - Optional, single valueComposed fields:
A cross-reference to related entries. Use \cf to start a cross-reference.
Simple fields:
\cf) - Required, single value\ce) - Optional, single value\so) - Optional, single value\cm) - Optional, single valueA grammatical paradigm or inflection. Use \pdl to start a paradigm.
Simple fields:
\pdl) - Required, single value\pdv) - Optional, single value\cm) - Optional, multiple allowedA list of paradigm items. Use \pd to start a paradigm list.
Simple fields:
\pd) - Required, single valueComposed fields:
An item within a paradigm list. Use \pdr to start a paradigm item.
Simple fields:
\pdr) - Required, single value\pdn) - Optional, single valueAn image associated with an entry. Use \pc to add an image.
Simple fields:
\pc) - Required, single value\so) - Optional, single value\sl) - Optional, single value\sa) - Optional, single valueA video associated with an entry. Use \vi to add a video.
Simple fields:
\vi) - Required, single value\so) - Optional, single valueAudio for the headword. Use \sf to add headword audio.
Simple fields:
\sf) - Required, single value\so) - Optional, single valueAudio for an example sentence. Use \sfx to add example audio.
Simple fields:
\sfx) - Required, single valueA semantic domain classification. Use \sd to add a semantic domain.
Simple fields:
\sd) - Required, single valueA semantic domain for an example. Use \sdx to add an example semantic domain.
Simple fields:
\sdx) - Required, single value