JDOC

Difference between revisions of "Categorising a chunk"

From Joomla! Documentation

m
 
m (moved Categorising a chunk to JDOC:Categorising a chunk: Moved page to the JDOC namespace as it discusses the documentation effort)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
It is important that all chunks are correctly categorised as it can be difficult to find them again otherwise.  This page gives the correct category tags to add to a page to make it a member of a particular category.  Each chunk should belong to at least 3 categories; one each from the following category groups:
 
It is important that all chunks are correctly categorised as it can be difficult to find them again otherwise.  This page gives the correct category tags to add to a page to make it a member of a particular category.  Each chunk should belong to at least 3 categories; one each from the following category groups:
# Chunk types
+
# [[:Category:Chunk types|Chunk types]]
#* Primary chunks
+
#* [[:Category:Primary chunks|Primary chunks]]
#** Definition lists: <nowiki>[[Category:Definition lists]]</nowiki>
+
#** [[:Category:Definition lists|Definition lists]]: <nowiki>[[Category:Definition lists]]</nowiki>
#** Glossaries: <nowiki>[[Category:Glossaries]]</nowiki>
+
#** [[:Category:Glossaries|Glossaries]]: <nowiki>[[Category:Glossaries]]</nowiki>
#** Procedures: <nowiki>[[Category:Procedures]]</nowiki>
+
#** [[:Category:Procedures|Procedures]]: <nowiki>[[Category:Procedures]]</nowiki>
#** Processes: <nowiki>[[Category:Processes]]</nowiki>
+
#** [[:Category:Processes|Processes]]: <nowiki>[[Category:Processes]]</nowiki>
#** Topics: <nowiki>[[Category:Topics]]</nowiki>
+
#** [[:Category:Topics|Topics]]: <nowiki>[[Category:Topics]]</nowiki>
#** Troubleshooting scenarios: <nowiki>[[Category:Troubleshooting scenarios]]</nowiki>
+
#** [[:Category:Troubleshooting scenarios|Troubleshooting scenarios]]: <nowiki>[[Category:Troubleshooting scenarios]]</nowiki>
#* Secondary chunks
+
#* [[:Category:Secondary chunks|Secondary chunks]]
#** Examples: <nowiki>[[Category:Examples]]</nowiki>
+
#** [[:Category:Examples|Examples]]: <nowiki>[[Category:Examples]]</nowiki>
#** Figures: <nowiki>[[Category:Figures]]</nowiki>
+
#** [[:Category:Figures|Figures]]: <nowiki>[[Category:Figures]]</nowiki>
#** Itemised lists: <nowiki>[[Category:Itemised lists]]</nowiki>
+
#** [[:Category:Itemised lists|Itemised lists]]: <nowiki>[[Category:Itemised lists]]</nowiki>
#** Notes: <nowiki>[[Category:Tables]]</nowiki>
+
#** [[:Category:Notes|Notes]]: <nowiki>[[Category:Tables]]</nowiki>
# User experience level
+
# [[:Category:User experience level|User experience level]]
#* Beginners: <nowiki>[[Category:Beginners]]</nowiki>
+
#* [[:Category:Beginners|Beginners]]: <nowiki>[[Category:Beginners]]</nowiki>
#* Intermediate: <nowiki>[[Category:Intermediate]]</nowiki>
+
#* [[:Category:Intermediate|Intermediate]]: <nowiki>[[Category:Intermediate]]</nowiki>
#* Advanced: <nowiki>[[Category:Advanced]]</nowiki>
+
#* [[:Category:Advanced|Advanced]]: <nowiki>[[Category:Advanced]]</nowiki>
#* Reference: <nowiki>[[Category:Reference]]</nowiki>
+
#* [[:Category:Reference|Reference]]: <nowiki>[[Category:Reference]]</nowiki>
# Joomla! Resource Type
+
# [[:Category:Joomla! Resource Type|Joomla! Resource Type]]
#* Components: <nowiki>[[Category:Components]]</nowiki>
+
#* [[:Category:Components|Components]]: <nowiki>[[Category:Components]]</nowiki>
#* Modules: <nowiki>[[Category:Modules]]</nowiki>
+
#* [[:Category:Modules|Modules]]: <nowiki>[[Category:Modules]]</nowiki>
#* Plugins: <nowiki>[[Category:Plugins]]</nowiki>
+
#* [[:Category:Plugins|Plugins]]: <nowiki>[[Category:Plugins]]</nowiki>
#* Templates: <nowiki>[[Category:Templates]]</nowiki>
+
#* [[:Category:Templates|Templates]]: <nowiki>[[Category:Templates]]</nowiki>
#* Languages: <nowiki>[[Category:Languages]]</nowiki>
+
#* [[:Category:Languages|Languages]]: <nowiki>[[Category:Languages]]</nowiki>
  
We also started to create ''wiki'' [[templates for chunk categorisation]] to simplify the process.
+
We also started to create ''wiki'' [[templates for chunk categorisation]] to simplify the process.<noinclude>
[[Category:Templates]]
+
[[Category:Documentation modules]][[Category:Documentation Working Group]]</noinclude>

Latest revision as of 15:20, 25 November 2011

It is important that all chunks are correctly categorised as it can be difficult to find them again otherwise. This page gives the correct category tags to add to a page to make it a member of a particular category. Each chunk should belong to at least 3 categories; one each from the following category groups:

  1. Chunk types
  2. User experience level
  3. Joomla! Resource Type

We also started to create wiki templates for chunk categorisation to simplify the process.