![[Show/Hide Right Column]](pics/icons/orightcol.png "[Show/Hide Right Column]"){kind=icon}
This page should merge with Status tags
How to Tag
In doc.tikiwiki.org pages can be "tagged" internally (to the wiki) by simply linking to the page which names the category or 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 PluginBacklinks to achieve a category or status index.Example
Here are the basic steps to this method of tagging:- Place a tag link (like stub, delete or errors) at the top of the page using the conventions described below
- If you're creating a new tag,
- make sure the tag page has a link to the Tag page, which has a list of all the backlinks to that page (using the PluginBacklinks)
- new tags related to documentation status should also be linked to the Documentation Status page, so that authors can see what needs to be worked on.
- consider adding a section to this page to explain the purpose of the tag.
Note: This informal method should not be confused with the Category or Freetags (also known as Folksonomy tags) features in Tikiwiki.
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.
Table of contents
Tagging Conventions
Tags are always placed inside of a text box to call attention to them like this:This is a sample tag. It's inside a text box
Use your Tag in a sentence, and add a sentence or two about why you placed the Tag, like this:
This is my sample tag. I've put it here because I need to show a sample tag.
Tagging to Indicate Documentation Status
These tags are used to highlight pages on this site that need attention from authors and indicate where the page is in the Documentation Lifecycle. By inserting these links as described below, the Documentation Status page will show up-to-date lists of pages that need work organized by Tag.help
The help Tag is used to identify a feature or setting that requires more info from a developer or more experienced user. Place the Tag at the point where help is needed. If you are tagging an 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 |
I need help understanding what the superformat feature 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.Many users are asking this question in IRC. Updating this page is an urgent requirement.
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:Add this page to the errors list. The procedure for creating a tracker does not include setting group permissions
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 examplePlease add this page to the refactor list. The feature was completely rewritten for version 2.0 and there are several new permissions that need to be included
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:
The screenshot of the admin panel should be replaced because we have new icons in version 2.x
stub
The stub Tag is placed at the top of an otherwise empty page, it should always invite participation to complete it with a link to the Welcome Authors page, like this:This page is a stub. You can help fill it in!.
needed for 3.0
This Tag is a note that the page needs to be updated or constructed for the next version of Tikiwiki. Place this Tag along with others on the page to indicate the page needs to be edited soon.This page is needed for 3.0
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:
This is new documentation that needs review.
or
I've added a screenshot of the newsreader admin page that needs review
or
The permissions setup section has been re-written and needs review
structure ready
The structure ready Tag is a request to add a page to a structure, so it will be included in Table of Contents and PDF's created from those structures. When you use this Tag, please place it at the top of the page and indicate which structure the page should be added to, like this:This page is structure ready, it should be added to the main documentation structure.
delete
Place a delete Tag on any page that you believe should be deleted, also giving the reason why. for example:This page is on the delete list because it has been superseded by ((''a page name here'')) .
merge
This is a proposal What do you think? Sometimes, we find two pages that are quite similar and we'd like to suggest a merge or to give people a chance to object to it.Creating Other Tags
Tags can be created for any reason, but realistically only the top 10 or so will make it on the Documentation Status page - and thus be watched. Other similar dashboard pages can be created however for special projects. If you'd like to implement a new Tag, you should first Tag the Tag by linking it to Tag. Get it?Please consult with the Editorial Board before you set new tags up.
,
,
,
.
In Progress