Latest Neocron News and Information
- New test server patch #563 has been released to Vedeena
Difference between revisions of "Legacy THNapi:Api No Index"
(New page: {{api | tag = api:no_index | command = Api_No_Index | usage = This command prevents any item db tags on the whole page from link to an item. | thn_only = no }} == Usage == Sometimes ...) |
(A bit of Guidance) |
||
| Line 12: | Line 12: | ||
Normally when the page is saved, the Wiki and the THN API would link the items to the ASG page. The '''<nowiki><api:no_index/></nowiki>''' turns off any linking for the ''whole page''. | Normally when the page is saved, the Wiki and the THN API would link the items to the ASG page. The '''<nowiki><api:no_index/></nowiki>''' turns off any linking for the ''whole page''. | ||
| − | To stop a single item being indexed simply add index="no" to the existing Item DB tag. (See [[THNapi:Parameter - Index]] for more information.) | + | To stop a single item being indexed simply add '''index="no"''' to the existing Item DB tag. (See [[THNapi:Parameter - Index]] for more information.) |
| + | |||
| + | == Guidance on using the tag == | ||
| + | |||
| + | For clarity in the article, the tag should be placed either at the end or the beginning of an article. | ||
| + | |||
| + | There currently is no policy on the usage of the '''<nowiki><api:no_index/></nowiki>''' It is left upto the best judgement of the NC-Wiki users and NC-Wiki sysops to decide if a page should not be indexed, or if certain items would be best to use '''index="no"''' on a item. | ||
| + | |||
| + | If you are not sure whether to use the tag, please use the talk page on the article to discuss the issue further. | ||
== Test pages == | == Test pages == | ||
Revision as of 13:04, 24 July 2008
Api No Index
- Item DB Tag: <api:no_index>
- Web service function: Api_No_Index
- Usage: This command prevents any item db tags on the whole page from link to an item.
Required parameters
Optional parameters
Usage
Sometimes it is not appropriate for a page to be indexed by the THN api linking layer. An example would be the ASG page where 2 vehicles are mentioned as Item DB tags.
Normally when the page is saved, the Wiki and the THN API would link the items to the ASG page. The <api:no_index/> turns off any linking for the whole page.
To stop a single item being indexed simply add index="no" to the existing Item DB tag. (See THNapi:Parameter - Index for more information.)
Guidance on using the tag
For clarity in the article, the tag should be placed either at the end or the beginning of an article.
There currently is no policy on the usage of the <api:no_index/> It is left upto the best judgement of the NC-Wiki users and NC-Wiki sysops to decide if a page should not be indexed, or if certain items would be best to use index="no" on a item.
If you are not sure whether to use the tag, please use the talk page on the article to discuss the issue further.
Test pages
Due to the way the THN API links articles and items only in the Main Namespace. So these test pages must be move to the Main namespace for testing, and should only be done on the NC-Wiki testing and development server. However these tests also serve as examples on the usage of tis tag and the index attribute.
