Menu

Home Log in to Edit

Andrew Burleson

Palette Documentation

Welcome to the Palette Documentation Wiki. This wiki is the primary source for all Palette Documentation.

Tag Structure

When creating an article, tagging it is critical. Don't just tag it with everything that you can think of, but please follow this tag guideline.

Top Level Tags

All articles should have exactly one top-level tag. These are:

  • Philosophy: An article that explains some aspect of the guiding design paradigm behind Palette.
  • Standards: An article that explains a specific coding or design standard.
  • Terms: An article that explains a specific term - basically a dictionary entry.
  • Classes: An article that documents a specific class.
  • Functions: An article that documents a function or a group of functions.
  • Files: An article that documents a specific file that cannot be described only in terms of its classes or functions.

Second Level Tags

Every article should have as it's second-level tag the specific name of the item it describes. This is for search optimization. ie the page on "Palette Objects" is called "Palette Objects", but it's second level tag would be "pal_object".


Discussion

Anonymous
Anonymous

Add attachments
Cancel