Pixar Cars Wiki:Documentation
| Documentation |
 |
|---|
| Conventions |
| Overview • Documentation tags |
| Notes |
| Templates • Parser function hooks • Parser extension tags System messages • Resource sheets • Internal files |
Meta documentation is maintained for several aspects of the system and software. This overview lays out all the conventions and instructions for keeping each category useful and up-to-date.
Function documentation
Wikitext (user)
All items of the following types should be fully informed with documentation tags using {{tdoc}}. Each type is recognized automatically and doesn't need to be specified. Note the latter two page groups exist only for documentation and need include only the DocBlock itself.
| Group | Doc list | System ref. list |
|---|---|---|
| Templates | Templates | Special:AllPages |
| Parser function hooks | Parser function hooks | Special:Version |
| Parser extension tags | Parser extension tags | Special:Version |
Lua
Same as above with the standard Doxygen * syntax, just with -- before each line. We are not currently using Docbunto but it is noted as an option.
JavaScript TBD.
Interface documentation
- Resource sheets (.css and .js)
- Gadgets have their own page, which should be updated along with user-end info at Help:Preferences.
- Interface (system) messages should list their default value, unless of course they didn't already exist via core or extension.
Property documentation
Individual trackers set up within the Help (Driver's Manual) pages. Meant to quick-link any editorial; the lists are not meant to be complete, except the internal file changes (see below). On the relevant page queries, please provide external resources to full documentation lists.
| Tracking | Table |
|---|---|
| Internal changes | Core_Changes |
| CSS Properties | DOC_CSS |
| (Lua) Scribunto Libraries | DOC_LUA_LIB |
Internal file documentation
All internal changes to the core system files must be documented. WinMerge is useful for directory comparison against the vanilla installation, but files themselves are tedious to check; Not to mention the general chore of trying to remember what something is, much less where it is. This will be of irreplaceable convenience when comes time to upgrade.
Changes should be kept as minimal as possible. // Comment out disabled lines rather than deleting them. NotePad++ with the "Compare" plug-in is recommended for line-by-line file comparison.
See also
- Special:Version - General auto-compiled installtion info.
- Help:Comments (especially #Good comments) - More on philosophy/good practice.