gplx/scripts/templates/Help_Adding_a_topic.wiki

60 lines
2.2 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This page explains how to add a new topic category to GxPlex so it appears automatically on [[Themes_and_topics|Themes and topics]].
== What is a topic? ==
A topic is a [[Special:Categories|category page]] that groups related regulatory documents. Every topic must belong to the parent category "Themes and topics" and carry a short description so it appears in the overview table.
== Adding a topic via the browser ==
=== Step 1 Open the new category page ===
Navigate to <code>http://&lt;wiki-url&gt;/index.php/Category:Your_Topic_Name</code> in your browser. The page will show "There is currently no text in this page." Click '''Create''' to start editing.
=== Step 2 Add the required content ===
Paste the following into the editor and adjust the highlighted parts:
<pre>
{{#set: Description=A one-sentence description of what this topic covers.}}
Pages in this category cover …
== Documents ==
{{#ask: [[Category:Your Topic Name]] [[Status::+]]
| ?Document name = Name
| ?Status = Status
| ?Area of validity = Region
| ?Version = Version
| format=table
| headers=show
| limit=50
| sort=Status
}}
[[Category:Themes and topics]]
</pre>
{| class="wikitable"
! Part !! What to change
|-
| <code>Description=…</code> || One sentence describing the topic — shown in the [[Themes_and_topics|Themes and topics]] table.
|-
| <code>Pages in this category cover …</code> || A short introductory sentence visible on the category page itself.
|-
| <code><nowiki>[[Category:Your Topic Name]]</nowiki></code> in the ask query || Replace with the exact name of your new category.
|-
| <code><nowiki>[[Category:Themes and topics]]</nowiki></code> at the bottom || '''Do not remove.''' This line makes the topic appear in the overview table.
|}
=== Step 3 Save ===
Click '''Save page'''. The new topic will appear on [[Themes_and_topics|Themes and topics]] immediately — no further steps needed.
== Removing a topic ==
Edit the category page and remove the line <code><nowiki>[[Category:Themes and topics]]</nowiki></code>, then save. The topic disappears from the overview on the next page load.
== Need help? ==
Contact the wiki administrator or see [[About_GxPlex|About GxPlex]].