This is about the controlled vocabulary that is used in the ProWikiScript for naming functions and global variables. Usually these are either English words (if they are short) or abbreviations. Note that - although the vocabulary looks very English - it is a kind of jargon so that common words often have specific meanings that deviate from everyday use.

Note:

• the understanding of "Get" and "Ret" is crucial, look them up first
• the "prime object" always starts a function name (FileSetStr isomorphic to file.setString)
• then the order is: operation, parameters
• modifiers follow the words they modify ("StrRetChrFirst" instead of "StrRetFirstChr")

General words

Word type abbreviation and meaning usage examples App operation from "append", to add at the end of some existing object content FileAppStr Auto modifier from "automatic" WordAutoLink AutoSubPageList AutoLinkStrategies Chr object from "character" ChrRetHex StrRetChrFirst Clear action to reset an Object to an empty standard state, compare to "Del"   Create action to create an object, need not be formal DirCreate Cvt action from "convert", the prime object is changed in place, function has usually no return value StrCvtUnicode($s) Del action from "delete", to remove an object, compare to "Clear" FileDel Get operation quite contrary to common programming use, "Get" means that the following parameters (references) are used for passing function results. Useful for Hashes and Array to avoid the overhead of passing many elements through the return value list. PageGetContext($id,%hash) Path object a filename potentially including directories and extensions PathRetDir Ret operation from "return" specifies the following parameters to be passed through the return value(s) of the function PageRetText StrRetUpper ChrRetHex WordRetLanguage Set operation prime object parameters are assigned FileSetStr Str object from "string", arbitrary sequence of characters FileAppStr StrCvtUnicode

Project specific words

Word type abbreviation and meaning usage examples Page object a wiki page, referenced by its string name e. g. "FrontPage", typical local variable name $id for complete page names PageRetText Show action deliver a WebPage to the client browsers ShowPage ShowFile ShowText Wiki object the LocalWiki if no modifier is used, no reference needed WikiRetPageList (none) object depending on the context, either the Wiki or the request ShowPage (means WikiShowPage), RetParam (means RequestRetParam)