History: Documentation Status

Source of version: 170 (current)

! Status Dashboard
{REMARKSBOX(type=information, title=info)}Do you want to help?: Welcome! and read ((Welcome authors)).
New to the new tagging system?: No problem (:wink:): Read on!{REMARKSBOX}
At Tiki.org, the "backlinks to index" method can be used to "mark" pages to indicate their status. This is a very simple and fast wiki-based method, using the ((PluginBacklinks)). If you think a status tag should apply to a page, just link that page to the appropriate status tag page. A tag can represent a step in the ((documentation lifecycle)) status, or can simply be used to highlight pages on this site that need attention from authors.

{REMARKSBOX(type=note, title=note)}__Authors__, please review the lists on this page and fix what you can! Please edit any of these pages and remove the status link if (in your opinion) the problem is resolved (or never existed).{REMARKSBOX}
{REMARKSBOX(type=note, title=note)}__Translators__, please __do not__ tag localised pages with the following tags. Taging the original version (in English) is enough, translations have the same status. You can create translation status tag for you langage thought if you wish{REMARKSBOX}

!!Tags
{TABS(tabs="delete|errors|help|in progress|merge|move|needs review|obsolete|refactor|screenshot|stub|structure ready|urgent" toggle="y" inside_pretty="n")}
Place a __delete__ Tag on any page that you believe should be deleted, also giving the reason why. For example:
^This page should be ((delete))d because it has been superseded by ~np~((''a page name here''))~/np~ .^
List of pages with the __delete__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status|Welcome Authors|talk: Manual of Style|Documentation Templates" include_self=>0,noheader=>1,page=>delete)}{BACKLINKS}
/////
If you think that you have found __errors__ in the document (misleading or plain wrong information), place this tag ===at the point where the error was found===, with an explanation of the error. For example:
^This page contain ((errors)). The procedure for creating a tracker does not include setting group permissions^
List of pages with the __errors__ tag:
{BACKLINKS(exclude="Documentation Lifecycle|Documentation Status" include_self=>0,noheader=>1,page=>errors)}{BACKLINKS}
/////
''a user is looking for help with a specific documentation problem''
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. For example:
||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.^
List of pages with the __help__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status",include_self=>0,noheader=>1,page=>help noheader=y)}{BACKLINKS}
/////
The __in progress__ tag indicate that the page or a paragraph is being edited heavily at the moment.
Write your name and the date next to this tag: Example:
^Work ((in progress)) (me, june 2013)^
List of pages with the __in progress__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status",include_self=>0,noheader=>1,page=>"in progress")}{BACKLINKS}
/////
Place a __merge__ tag in a page that you think is a duplicate of, or is too similar/complementary to another page. For example:
^This page should ((merge)) with ~np~((this other page))~/np~^
List of pages with the __merge__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status",include_self=>0,noheader=>1,page=>merge)}{BACKLINKS}
/////
The __move__ tag is for pages that should be moved to another Tiki site.
List of pages with the __move__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status",include_self=>0,noheader=>1,page=>move)}{BACKLINKS}
/////
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. Examples:
^This is new documentation that ((needs review)).^
^I've added a screenshot of the newsreader admin page that ((needs review))^
^The permissions setup section has been re-written and ((needs review))^
List of pages with the __needs review__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status",include_self=>0,noheader=>1,page=>"needs review")}{BACKLINKS}
/////
The __obsolete__ tag indicate that a page's content has to be renewed. Example:
^This page is ((obsolete)) since Tiki X^
List of pages with the __obsolete__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status",include_self=>0,noheader=>1,page=>obsolete)}{BACKLINKS}
/////
''the page needs to be re-organized, possibly using a ((documentation template))''
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.  Examples:
^Please 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^
^Please ((refactor)). This page needs to be re-organized using one of the ((documentation templates))^
List of pages with the __refactor__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status",include_self=>0,noheader=>1,page=>refactor)}{BACKLINKS}
/////
The __screenshot__ Tag is a request for adding missing or replacing obsolete screenshot(s). It should be placed at the point where change is needed and contain an explanation. For example:
^The ((screenshot)) of the admin panel should be replaced because we have new icons in version x^
List of pages with the __screenshot__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status",include_self=>0,noheader=>1,page=>screenshot)}{BACKLINKS}
/////
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 ((Welcome Authors|fill it in!)).^
List of pages with the __stub__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status|Welcome Authors",include_self=>0,noheader=>1,page=>stub)}{BACKLINKS}
/////
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.^  
List of pages with the __structure ready__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status|Welcome Authors|talk: Manual of Style|Documentation Templates",include_self=>0,noheader=>1,page=>"structure ready")}{BACKLINKS}
/////
''can be combined with any of the above, indicating well, um urgency ''
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. An urgent Tag can be combined with any of the other tags and should be placed at the top of the page. For example:
^Many users are asking this question in IRC.  Updating this page is an ((urgent)) requirement. Please ((help))^
List of pages with the __urgent__ tag:
{BACKLINKS(exclude=>"Documentation Lifecycle|Documentation Status",include_self=>0,noheader=>1,page=>urgent)}{BACKLINKS}
{TABS}

!! How to Tag
!!!How-to
*See the section above for the list of existing tags and pick the one you think is most appropriate for the page you are targeting
*Edit the targeted wiki page
**Place a wiki link at the top of the target page to the appropriate tag page
++Use the normal syntax for an internal link:  ~~#900:~np~((stub)), ((delete)) or ((errors))~/np~~~
**Use your tag in a sentence, and add a sentence or two about why you placed the tag
**Add a box around the text to call attention to it
*Save edit

!!!Example
Code:
{CODE()}^Many users are asking this question in IRC.  Updating this page is an ((urgent)) requirement. Please ((help))^{CODE} Result:
^Many users are asking this question in IRC.  Updating this page is an ((urgent)) requirement. Please ((help))^

!!!Creating Other Tags
* Make sure there's not already another tag that you could use (see [#Tags|above]),
* consult the ((two:Documentation Team|Editorial board)),
* create a wiki page with the name of the tag you want to create, and on that page:
** add a ((PluginBacklinks)) with no parameters set
** add an internal link to ((Tag)) or ((Documentation Status)) (either of these will link to this page)
* edit this current page (''Documentation Status'') and add a tab for your tag in the [#Tags|chapter above], or add a comment to the page,
* add an explaination on the purpose of the tag in the new tab/comment,
* consider adding a section to this page to explain the purpose of the tag.

!!Related Pages
*((WantedPages))
*((Tutorials))
* ((Documentation Lifecycle))
__Note:__ This informal method should not be confused with the ((Category)) or ((Freetags)) (also known as Folksonomy tags) features in Tikiwiki. 


-=Alias names of this page:=-
(alias(How to Tag)) | (alias(Status Tags)) | (alias(Tag))

!!!-Editor notes
todo:
*migrate the category system to the backlink system
+done so far :
**((obsolete)) 12 (new tag)
**to-do 85 ( ((stub)) )
**reviewed 4
**validated 1
**live 21
**pending review 98 ( ((needs review)) )
**Should be moved to another site 15 ( ((move)) )
+to do :
**((in progress)) 222 (new tag)
+see [tiki-browse_categories.php?parentId=1&deep=off&type=|status categories]

{PARAM(name="structure")} {ELSE}{redirect page="{{page}}&structure=HomePage+Author"}{PARAM}