Difference between revisions of "Glossary"
From Joomla! Documentation
(→Notes on how to write a Glossary entry: Updated contents) |
|||
| 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 [[Project:Chunks|documentation chunk]]. | + | 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> | ||
{{Chunk:Extension}} | {{Chunk:Extension}} | ||
| Line 6: | Line 6: | ||
</pre> | </pre> | ||
| − | Save the page, then click on the "Chunk:Extension" link that you will see. | + | Save the page, then click on the "Chunk:Extension" link that you will see. Enter your glossary explanation there. At the end of the page, add the following text to make it appear in the Glossary. |
| − | + | '''Make sure there is nothing (not even a newline) between the last character of your text and the following.''' | |
| − | |||
<pre> | <pre> | ||
| − | + | <noinclude>[[Category:Glossary definitions|{{PAGENAME}}]]</noinclude> | |
| − | {{ | ||
</pre> | </pre> | ||
| − | |||
| − | If the term has a commonly used plural form then you should add a redirect to the singular form. | + | 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: |
<pre> | <pre> | ||
#REDIRECT [[Extension]] | #REDIRECT [[Extension]] | ||
[[Category:Landing Pages]] | [[Category:Landing Pages]] | ||
</pre> | </pre> | ||
Revision as of 08:11, 25 September 2011
Notes on how to write a Glossary entry[edit]
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. At the end of the page, add the following text to make it appear in the Glossary. Make sure there is nothing (not even a newline) between the last character of your text and the following.
<noinclude>[[Category:Glossary definitions|{{PAGENAME}}]]</noinclude>
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]]