Manual 1 6/Appendix 1 Guidance/3 Naming Conventions

From Joomla! Documentation

Jump to: navigation, search
Warning - Joomla! 1.6 has not been released yet.
This article contains preliminary information which is subject to change.

Joomla! 1.6 User Manual

3 Naming Conventions

Manual 1 6/Appendix 1 Guidance/3 Naming Conventions has no subpages to list.

Contents



Can I Create a New Page?

Please fell free but please follow the Naming Conventions here.

  • This Manual is a tree.
  • At the top of each page an inserted routine builds the standard page header.
  • Pages must be named according to the following convention for that to work.
  • These conventions will also help in two further important areas to improve the already wide appeal of Joomla!
    • Help Pages - it is intended that the Manual and Help Pages should share the same text. These conventions help that.
    • Localisation - it is easier to manage multi lingual pages if these conventions are followed.
  • Make the name MEANINGFUL. You can use names with spaces between words. Wikipedia swops between spaces and underscores depending on context.
  • NEVER use dot separators. They confuse mod_rewrite and create loads of hassle
  • Group in the usual directory manner using forward slashes /
    • The Manual Header will then
      • Put the last part of the URL at the top of the page.
      • Provide a link back up to the level above.
      • Create a Table of Contents for your page with internal anchors.

Example
Here is a simple example of a page which is not likely to change rapidly.
It has been used as a device to stop the URL's growing too long.


  • Please ask if you have any problems
  • Thank you for contributing.
Personal tools