Actions

Talk

Difference between revisions of "Glossary"

From Joomla! Documentation

(New page: ==Notes on how to write a Glossary entry== Create a page for the term (in its singular form if relevant) but instead of entering the text directly include the term as a MediaWiki template....)
 
m (Notes on how to write a Glossary entry)
Line 1: Line 1:
 
==Notes on how to write a Glossary entry==
 
==Notes on how to write a Glossary entry==
Create a page for the term (in its singular form if relevant) but instead of entering the text directly include the term as a MediaWiki template.  Add the page to the Glossary category and if required (which is the norm) add it to the Landing Pages category too.  For example, for the term "extension", create a page called "Extension" (the first letter is automatically capitalised so don't worry about that).  In the page enter the following text:
+
Create a page for the term (in its singular form if relevant) but instead of entering the text directly include the term as a [[Project:Chunks|documentation chunk]].  Add the page to the Glossary category and if required (which is the norm) add it to the Landing Pages category too.  For example, for the term "extension", create a page called "Extension" (the first letter is automatically capitalised so don't worry about that).  In the page enter the following text:
 
<pre>
 
<pre>
{{Extension}}
+
{{Chunk:Extension}}
[[Category:Landing Pages]][[Category:Glossary]]
+
<noinclude>[[Category:Landing Pages]][[Category:Glossary]]</noinclude>
 
</pre>
 
</pre>
  
Save the page, then click on the "Templates:Extension" link that you will see.  Enter your glossary explanation there and save it.
+
Save the page, then click on the "Chunk:Extension" link that you will see.  Enter your glossary explanation there and save it.
  
 
Now go to the [[Glossary]] page and add an entry for the new term in alphabetical order.  Use a template reference here too.  So, continuing the above example, you would enter the text:
 
Now go to the [[Glossary]] page and add an entry for the new term in alphabetical order.  Use a template reference here too.  So, continuing the above example, you would enter the text:
 
<pre>
 
<pre>
 
==Extension==
 
==Extension==
{{Extension}}
+
{{Chunk:Extension}}
 
</pre>
 
</pre>
 
at the appropriate point, then save it.
 
at the appropriate point, then save it.

Revision as of 07:16, 11 May 2008

Notes on how to write a Glossary entry

Create a page for the term (in its singular form if relevant) but instead of entering the text directly include the term as a documentation chunk. Add the page to the Glossary category and if required (which is the norm) add it to the Landing Pages category too. For example, for the term "extension", create a page called "Extension" (the first letter is automatically capitalised so don't worry about that). In the page enter the following text:

{{Chunk:Extension}}
<noinclude>[[Category:Landing Pages]][[Category:Glossary]]</noinclude>

Save the page, then click on the "Chunk:Extension" link that you will see. Enter your glossary explanation there and save it.

Now go to the Glossary page and add an entry for the new term in alphabetical order. Use a template reference here too. So, continuing the above example, you would enter the text:

==Extension==
{{Chunk:Extension}}

at the appropriate point, then save it.

If the term has a commonly used plural form then you should add a redirect to the singular form. To do this create a page for the plural form and add a #REDIRECT statement to it. If required (which is the norm) add it to the Landing Pages category too. Do not add it to the Glossary category. For example, to add the term "extensions" which will redirect to "extension", create a page called "Extensions" and enter the following text:

#REDIRECT [[Extension]]
[[Category:Landing Pages]]