Please submit only plain ASCII text, or Docbook XML. Anything else will be returned to you. (Docbook XML is preferred.)
Make sure you first read, and follow, the documentation template
provided. You can find this in the source folder for TDE. Simply
point a browser to tdelibs/doc/kdoctools/template.docbook
If there is existing documentation (from the developer, or from TDE 1.x or 2.x), then use that as a base to work from, but it needs to conform to the layout from the documentation template.
Spell things according to Standard American spelling, except for proper names, places, etc.
Make sure to set your spell checker to US English. Make sure you use your spell checker.
If there is a non-English word, which is used in an English sentence, be sure to spell this correctly, using appropriate accent marks, and any special characters. Use the KCharSelect application if you don't have the correct keys on your keyboard.
Abbreviations should be capitalized, unless they are specifically intended to not be capitalized. (that is, is a good example).
Punctuation within numbers should be Americanized: 10,000.00
It is more legible to use written numbers where the number has no technical value, for example, “There are three buttons on the dialog”. In this context “3” is not technically significant. Numbers with technical significance should be written as figures. (that is, “a 10 MB file”, not “a ten MB file”.)
Spell check and proofread your work before you send it in. Or even better, have someone else read it over. Spell checking programs won't catch incorrect words such as using “their” for “there”.
Would you like to comment or contribute an update to this page?
Send feedback to the TDE Development Team