How to Tag

In the KLOI wiki, pages can be "tagged" internally (to the wiki) by simply linking to the page which names the status you wish to apply. It is a simple, fast and effective way to keep track of things like documentation status. This has been dubbed the Backlinks to index method, since it uses the BacklinksPlugin to achieve a category or status index.



Tagging like this will notify other users who are watching the Status Page page that refactoring help is needed.

Editors can use and create tags to index what work needs to be done on each page. As pages move through the Documentation Lifecycle, their status changes. When they are complete and in production, the tags are removed. It's important to Tag things properly, so that you communicate clearly with your fellow editors.

Tagging Conventions

Tags are always placed inside of a text box to call attention to them like this:


Use your Tag in a sentence, and add a sentence or two about why you placed the Tag, like this:

More Examples

Stub

The stub Tag is placed at the top of an otherwise empty page, like this:

Refactor

The Refactor Tag is a request to make substantial changes to a page. It should be placed at the top of the page. The Tag should include the reasons why the change is needed. For example

Screenshot

The Screenshot Tag is also a request for a change. It should be placed

• just before the screenshot that needs to be replaced
• at the point where a screenshot needs to be created

This Tag should also include the reason why a change is needed. For example:

Errors

If you think that you have found errors in the document, place an error Tag at the point where the error was found, with an explanation of the error:

Needs Review

This Tag is used many times in the Documentation Lifecycle:

• After new documentation is created
• After screenshots have been added or replaced
• After errors have been corrected
• After refactoring

In short, after every major edit the document should go back to needs review status. Please give a brief description of what was changed to save the review editor the time of digging through page history, like this:

or

or

Help

The help feature is used to Tag a feature or setting that requres more info from a developer or more experienced user. Place the Tag at the point where help is needed. If you are tagging at item inside a wiki table, place a Tag in the table at the spot you need help and put a box underneath the table:

Upper Case Allowed?	Allows upper case if checked
Superformat?	I need help understanding what superformat does

Urgent

If you feel a page needs to be worked on ahead of others, you can Tag it as urgent. Valid reasons for using urgent would be highly used page with errors, key new feature, security info, etc. There's no guarantee the other editors will share your sense of urgency, so it's best to edit the page yourself. Please add the urgent Tag at the top of the page.