Actions

Talk

Difference between revisions of "Glossary"

From Joomla! Documentation

m (Notes on how to write a Glossary entry)
m (doubled)
 
(7 intermediate revisions by 3 users not shown)
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]]. 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>
 
{{Chunk:Extension}}
 
{{Chunk:Extension}}
Line 6: Line 6:
 
</pre>
 
</pre>
  
Save the page, then click on the "Chunk: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. 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.'''
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==
+
<noinclude>[[Category:Glossary definitions|{{PAGENAME}}]]</noinclude>
{{Chunk:Extension}}
+
 
</pre>
 
</pre>
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:
+
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>
 +
 +
== Updating The Glossary ==
 +
 +
I've marked this page as needs review as
 +
#I feel that having Mambots on the list of extensions is plain unhelpful.
 +
#I feel there is no need to have Joomla 1.5 references on this list anymore (references to Legacy mode, Sections etc.)
 +
#The upgrade package section needs to be updated ironically to mention the Joomla Updated that shipped in 1.7
 +
 +
Before I make this changes how do people feel about removing anything that isn't still relevant from Joomla 1.5 and earlier
 +
 +
== Translation Hints ==
 +
 +
Suggested markup for translations
 +
 +
Will have to work this out, but it does work and will use the /en coding for English pages once they are all marked for translation.
 +
<pre>
 +
DPL Call between tags
 +
category=Glossary definitions/<lang code>
 +
notcategorymatch=%Archived%
 +
include=*
 +
format=,\n== {{#ifexist:%TITLE%|[[%TITLE%|{{:Translations:%TITLE%/Page_display_title/<lang code>‎}}]]|%TITLE%}} ==\n
 +
reset=categories
 +
resultsheader=__TOC____NOEDITSECTION__
 +
...end DPL call
 
</pre>
 
</pre>

Latest revision as of 15:25, 24 February 2014

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. 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]]

Updating The Glossary

I've marked this page as needs review as

  1. I feel that having Mambots on the list of extensions is plain unhelpful.
  2. I feel there is no need to have Joomla 1.5 references on this list anymore (references to Legacy mode, Sections etc.)
  3. The upgrade package section needs to be updated ironically to mention the Joomla Updated that shipped in 1.7

Before I make this changes how do people feel about removing anything that isn't still relevant from Joomla 1.5 and earlier

Translation Hints

Suggested markup for translations

Will have to work this out, but it does work and will use the /en coding for English pages once they are all marked for translation.

DPL Call between tags
category=Glossary definitions/<lang code>
notcategorymatch=%Archived%
include=*
format=,\n== {{#ifexist:%TITLE%|[[%TITLE%|{{:Translations:%TITLE%/Page_display_title/<lang code>‎}}]]|%TITLE%}} ==\n
reset=categories
resultsheader=__TOC____NOEDITSECTION__
...end DPL call