Actions

JDOC

Difference between revisions of "Joomla! versions"

From Joomla! Documentation

m (Page names: clean up)
m (Page names: update)
Line 15: Line 15:
 
== Page names ==
 
== Page names ==
  
Some pages apply specifically to one version or some versions of Joomla!. In these cases, it makes sense to insert the version number(s) into the page title.
+
The Joomla! Documentation Wiki articles are placed in a version appropriate or descriptive namespace. This helps identify the text of the article with the version of Joomla it refers too. For example, the top of this page should show JDOC in a blue block. The title of the article is shown in the URL address bar as "JDOC:Joomla!_versions" with just the title below the blue block showing the namespace. JDOC, signifies it is the "project" or wiki's namespace for documentation articles. These articles would be for information, procedures, styles, instructions, etc. for using Joomla Documentation's website. If this article was for Joomla 2.5, you would see a J2.5 in the blue box and likewise the article's name would really be "J2.5:Joomla! versions."
 +
 
 +
Some pages apply to more than one version or some versions of Joomla!. These may or may not be version specific and apply across multiple or all versions of Joomla. In these cases, no prefix should be used. For example, the article's name is "Using TinyMce as My Editor" which could apply to all Joomla versions. So you would not have a J2.5 or J3.x as a prefix and no blue box will appear.
 +
 
 +
For further reading and to find out about all the namespaces used on this wiki, please see [[JDOC:Namespaces]].
  
Currently, there is no consensus on the naming scheme for page titles. Authors should decide if and how to mention version numbers. If maximum clarity is required, version numbers should be incorporated '''directly into the text''' (e.g. ''User management in Joomla! 1.5''). '''Subpages''' can be used if many different pages are necessary (e.g. ''User management/1.0'', ''User management/1.5'', ''User management/1.6'').
 
 
<noinclude>[[Category:Documentation Wiki Information]]</noinclude>
 
<noinclude>[[Category:Documentation Wiki Information]]</noinclude>

Revision as of 13:17, 5 February 2014

This Wiki aims to document as many (non-deprecated) versions of Joomla! (both the CMS and the Platform) as possible so as to provide relevant information for all users. Therefore it is important to indicate the version(s) each piece of information (e.g. page, paragraph) applies to clearly and uniformly. This page summarizes and explains the methods for organizing and tagging Wiki content with specific versions.

Icons

Icons are a quick and familiar way for users to recognize whether a page applies to their version of Joomla. Icons can currently be added using the JVer template, which can be used for placing CMS version icons, Platform verson icons and a generic Platform icon. For example,

  • {{JVer|1.7}} will produce Joomla 1.7
  • {{JVer|11.1}} will produce Joomla 11.1
  • {{JVer|platform}} will produce Joomla platform

Categories

Placing pages in subcategories of Category:Joomla! versions ensures they can be found through the index page for the corresponding Joomla! versions. You can place a page in more than one category if it applies to multiple versions of Joomla!.

Page names

The Joomla! Documentation Wiki articles are placed in a version appropriate or descriptive namespace. This helps identify the text of the article with the version of Joomla it refers too. For example, the top of this page should show JDOC in a blue block. The title of the article is shown in the URL address bar as "JDOC:Joomla!_versions" with just the title below the blue block showing the namespace. JDOC, signifies it is the "project" or wiki's namespace for documentation articles. These articles would be for information, procedures, styles, instructions, etc. for using Joomla Documentation's website. If this article was for Joomla 2.5, you would see a J2.5 in the blue box and likewise the article's name would really be "J2.5:Joomla! versions."

Some pages apply to more than one version or some versions of Joomla!. These may or may not be version specific and apply across multiple or all versions of Joomla. In these cases, no prefix should be used. For example, the article's name is "Using TinyMce as My Editor" which could apply to all Joomla versions. So you would not have a J2.5 or J3.x as a prefix and no blue box will appear.

For further reading and to find out about all the namespaces used on this wiki, please see JDOC:Namespaces.