DjVoo

FAQ What's New

Table of Contents [show]     1 Introduction     2 Input Suggestions (disabled for now for performance purposes)       2.1 How to select a word from the suggestion list?     3 Navigating the result page       3.1 The title       3.2 The search box       3.3 You-Defined Definitions       3.4 Comments       3.5 The dictionary search results       3.6 The footer     4 Adding Your Own Definitions       4.1 Using HTML tags       4.2 Using DjVoo-specific tags         4.2.1 Escaping         4.2.2 Titles         4.2.3 New paragraphs         4.2.4 Web addresses and links         4.2.5 Maps         4.2.6 Images         4.2.7 Ordered and unordered lists         4.2.8 Section headers         4.2.9 The <r> tag         4.2.10 The <k> tag         4.2.11 The <c> tag         4.2.12 The <fn></fn> tag         4.2.13 Protect your article with passwords         4.2.14 The <cp> tag       4.3 Using Latex tags       4.4 Trouble-shooting     5 Add comments     6 Credits       6.1 Header syntax       6.2 Input suggestion and auto-complete       6.3 Webster Unabridged       6.4 English-Chinese       6.5 Medical dictionary       6.6 City data       6.7 VERA       6.8 Element dictionary     7 How to link to DjVoo and copyright issues     8 DjVoo Development Keywords DjVoo, GNU Free Documentation License, Google Suggest, HTML, Homemade Dictionary, Java, Jay Kominek, MediaWiki, Microsoft MSDN, Object Graph Dictionary, US Census Bureau, VERA acronym, Wiki Copyright Information All rights reserved by the author of this article. Contact webmasters for more information on copyright issues. 1 Introduction DjVoo is a simple yet hopefully useful dictionary and Wiki system. DjVoo combines the power of a Wiki system and dictionaries. First, it is a dictionary where you can lookup words. At the same time, like a classic wiki system, you can add your own definitions and comments. DjVoo also has a feature called input suggestion feature which suggestions as you type in words. Using DjVoo, you can look up in the following dictionaries: You-Defined Entries Webster Unabridged Dictionary US City Data: Demography and Geography V.E.R.A Acronyms Chemical Elements Medical Dictionary English-Chinese Dictionary 2 Input Suggestions (disabled for now for performance purposes) As you type in your query, DjVoo will automatically suggest a list of words that are already in our dictionaries and wiki database. 2.1 How to select a word from the suggestion list? Use your mouse to select a word in the popup suggestion box and click on that item, or use the up/down arrows to highlight an item and press ENTER to select it. Press ESC to cancel a selection. 3 Navigating the result page After you type in your keyword and hit the "search" button, you get a pageful of definitions for you keyword. Here is a list of items on this result page in a top-down order: 3.1 The title The title looks something like "DjVoo - your keyword - Edit". Clicking on "DjVoo" takes you to the DjVoo homepage, while clicking on "Edit" allows you to add your own definitions. 3.2 The search box The search box section lies below the title. On the left-most is an input box where you can key in your keyword (check out our automatic input suggestion feature). Then there is a search button, which takes you the result page. Click on the image with a question mark takes you to the help page. The "what's new" link contains new features we'be been working on. 3.3 You-Defined Definitions Then comes the DjVoo definition for your keyword, if there is any. A typical DjVoo definition usually contains the following sections: a table of contents section (if there are more than one section), a keywords section which is extracted from the <k> DjVoo keyword, a bunch of sections on the specific topic, and a references section which is extracted from the <c> keywords. 3.4 Comments Readers may comment on your article, this section contains all user comments. Please read on to find out how to add comments. 3.5 The dictionary search results Results from the dictionaries come right after the DjVoo definition. To view the results from a specific dictionary, click the dictionary name. 3.6 The footer The footer section has links to service provider and this page. 4 Adding Your Own Definitions Here are a few tips on editing a DjVoo article. 4.1 Using HTML tags DjVoo supports almost all HTML tags. For example, if you want to link the keyword HTML to an exterior URL: http://www.w3.org/MarkUp/. You use the following <a href="http://www.w3.org/MarkUp/">HTML<a> Here are two tags you will find especially useful: the <p> tag for new paragraphs, and <br> tag for line breaks. 4.2 Using DjVoo-specific tags There are also a few DjVoo-specific tags. These tags have been designed to make it easier for you to create your own definition. They are HTML-alike, therefore they are pretty easy to use if you are already familiar with HTML. 4.2.1 Escaping If you want to use djvoo-specific tags in your article, then you have to escape them by adding the \ character to break the tags. For example, if you have a "===" string in your article which you do not want to use as header tag, use "\=\=\=" instead. Currently, you should escape the following characters: #, *, =, and \ itself. 4.2.2 Titles Use <title>your title</title > to set the title of your artile. This is optional, the default title is the keyword. 4.2.3 New paragraphs Since all html tags are supported, therefore you could use <p> to separate paragraph if you are used to html tags. Otherwise, just put a null line between two paragraphs. 4.2.4 Web addresses and links There are two type of web address links: named and unnamed. To create an unamed link to URL (URL should start with http), you put the URL string into a pair of brankets, then this string will be translated into a link to that URL. For example, [URL] will be translated into <a href="URL">URL</a>, where URL is a string starting with http. To create a named link to URL, you use this format: [title:URL], where URL also starts with http. [title:URL] will be translated into <a href="URL">title</a> 4.2.5 Maps Use <map>your address</map> to link to google maps. 4.2.6 Images To add short notes to your images (as in Nanjing Massacre), format your image tag in this fashion <img width="a number" src="url" alt="your note here"> Note that the double quotes are required fields. Please refer to img demo for a working example. 4.2.7 Ordered and unordered lists Ordered list: *** * item1 * item2 * item3 *** produces item1 item2 item3 Unordered list *** # item1 # item2 # item3 *** produces item1 item2 item3 4.2.8 Section headers You could use HTML tags such as <h2> to add headers, they will work. However, we strongly recommend you to use our DjVoo-specific header format: equal-signs header content equal-signs. For example, to create a third level header, you first type in three equal signs, and then type in your header followed by three equal signs. This will generate <h3>your header</h3>. Here are the advantages about using the DjVoo-specific headers: DjVoo will automatically generate a table of contents section for you. It won't if you use HTML header tags. For the section titles, DjVoo will automatically generate a numerical section serial number and add it in front your header. For example, "your header" may be changed into "2.3.1 your header". 4.2.9 The <r> tag Since html tags are supported, the <r> tag is added to support raw html statements. For example, if you want to show the following html tag: <sometag>some text</sometag>, surround these html statements by the r tag. 4.2.10 The <k> tag The <k> keyword is supported for generating links to keywords in DjVoo system. For example, to link to BBB, use the following: <k>BBB</k>. DjVoo will create a link to the definition of BBB. Then it checks if there is a BBB definition. If there is not, a back-link is created for that keywork. For example, if you are defining AAA, and in AAA there is <k>BBB</k>. DjVoo first checks if there is a definition for BBB. If not, it creates a link to the current AAA definition as a place holder. This is useful when you are defining multiple interrelated terms in one single page. If a section title contains only one <k> tag, for instance, = =<K>sometopic</K>= =, a digest will be inserted. The digest (or intro) will be generated from the definition of the corresponding keyword. Take a look at Java for a complete example. 4.2.11 The <c> tag You could use the <c></c> keyword to add citation information. For example, <c>PostgreSQL website</c> will be translated to citation information: (Source: PostgreSQL website). 4.2.12 The <fn></fn> tag This pair of tags allow you to add footnotes. A separate footnotes section will be created if there is footnote in this section. 4.2.13 Protect your article with passwords <pw> tag allows us to use passwords to protect articles from being edited by unauthorized parties. For example, the following article is protected by the password "abc". Next time when anybody tries to edit this article, he or she will be prompted for this password. Similarly, we can use <pr> pairs to protected article from being read by unauthorized parties. Some text here.... <pw>abc</pw> some other text here.... Note that an article can have multiple passwords. People who know any one of them will be able to edit the article, (and remove or change passwords too!). Also, note that If neither read password nor edit password is defined, then everybody can read/edit the article If only read password is defined, you will need this password to read or edit the article If only edit password is defined, everybody can read this article, and you will need the correct edit password to edit the article If both read and edit passwords are defined, then you'll need read or edit password to read the article, and you will need edit password to edit the file. 4.2.14 The <cp> tag Use <cp></cp> pair to specify the copyright information of your article. If you use cp pairs to explicitly specify your copyright information, your info will be shown in this section If not, then if you have defined passwords, then the following copyright info will be shown All rights reserved by the author of this article If not either, GNU Public License applies. 4.3 Using Latex tags Linux style new lines and new paras are also supported. Therefore, to add a new line you could either go with <br> or just backslash backslash. To add a new paragraph, you could use either <p> or backslash par. 4.4 Trouble-shooting One most common error you might see with DjVoo is hanging empty pages: you get a white page with nothing on it, however, the browser seems to be busy at the same time. This is most probably because you have unmatched <k> tags. Check to make sure every <k> tag has its matching </k> 5 Add comments To add comments, either click the comment image at the top of the page, or click the buttons in the comments section at the end of an article. 6 Credits 6.1 Header syntax The equal-sign section header syntax has been adapted from MediaWiki 6.2 Input suggestion and auto-complete The idea of input suggestions (auto-complete) has been adapted from Google Suggest, Object Graph Dictionary, Microsoft MSDN, etc. 6.3 Webster Unabridged The Webster Unabridged Dictionary input has been adapted from the public domain Project Gutenberg Etext of The 1913 Webster Unabridged Dictionary Version 0.50 Letter C: #661 by MICRA, Inc. 6.4 English-Chinese The English-Chinese dictionary database has been adapted from the open source database XDict system by Jianjun Fu, et al. 6.5 Medical dictionary Medical dictionary database has been adapted from the open source Homemade Dictionary system. 6.6 City data City data has been adapted from the US Census Bureau. 6.7 VERA V.E.R.A has been adapted from the VERA acronym computing acronym database. 6.8 Element dictionary Elements database has been adapted form the public domain element database compiled by Jay Kominek. Thanks Jay, you did a great job. 7 How to link to DjVoo and copyright issues Use <a href="http://www.djvoo.net/d/keyword">keyword<a> to link to DjVoo. DjVoo documents are licensed under GNU Free Documentation License unless otherwise noted. 8 DjVoo Development Suggestions Use Algorithm::Diff to support versions Links to WikiPedia, dictionaries.com, MerriamWebster, etc. ...[more] Comments