Director Online Wiki:Dictionary guidelines
This is an early draft for a guidline for dictionary entries. Feel free to enhance it or to discuss it on the DOUG_talk:Dictionary guidelines
An expample can be seen at importFileInto.
Template/Guidelines:
dummy importFile
| |
|---|---|
| Type: | method |
| Version: | MX |
| Language: | Lingo |
| Dependencies: | some Xtra? |
| Properties | |
| length: | Info? |
| Methods | |
| destroy: | Info? |
| new: | other info? |
| Links/Related | |
| newMember, import | |
Infobox: A simple overview about dependencies or requirements - and for example to which scripting language this keyword belongs, and what Xtra this possibly needs. Also type (object/keyword/property), and Director version.
Contents
Description
Describe in a short paragraph for what this keyword is useful.
Syntax/Usage
describe here the syntax variants (There could be some guidelines for that).
example(parameters)
Undocumented Syntax
Talk here about undocumented stuff. Either undoc'ed features or in case the keyword is completely undocumented.
Properties
- If the keyword is a type (like member) then list all the properties here.
Methods
- If the keyword is a type then list all available methods here.
Example code
- a "real world" example of the keyword/type
- try to stick to the DOUG:Coding conventions (at least for longer code snippets)
Bugs/Quirks/Problems
List all the bugs or problems that you know about this keyword.
See also
Useful internal links or related dictionary-entries
External links
Then dont forget to enter the proper category: [[Category:Dictionary]] [[Category:Lingo]] [[Category:Javascript]]
See also: DOUG:Coding conventions, DOUG_talk:Coding conventions, DOUG_talk:, Lingo Dictionary, JavaScript Dictionary