Difference between revisions of "Template:Deprecated page"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
For information on this deprecated functionality, see the version {{{1}}} platform | For information on this deprecated functionality, see the version {{{1}}} platform documentation:<br> | ||
{{SERVER}}/ | {{SERVER}}/{{{2}}}/index.php?title={{PAGENAMEE}} | ||
<includeonly>[[Category:Deprecation]]</includeonly> | <includeonly>[[Category:Deprecation]]</includeonly> | ||
<noinclude> | <noinclude> | ||
---- | ---- | ||
;Usage: | ;Usage: | ||
<blockquote> | <blockquote> | ||
<tt><nowiki>{{deprecated_page| | <tt><nowiki>{{deprecated_page|{version}|{wiki}}}</nowiki></tt> | ||
:=> "see the version {version} docs at .../{wiki}/{page with same name as current page} | |||
</blockquote> | </blockquote> | ||
This pragma is added in the third stage of the deprecation process: | |||
:* In the first stage, a [[Template:DeprecationPlanned]] note is added at the top of existing documentation. Users can still see it, but have a warning that it will be deprecated. | |||
:* In the second stage, [[Template:Deprecated]] note is added, saying that the feature has been deprecated. Most if not all of the links to the page are removed, making it harder to find. (Often, the process starts here. Deprecation planned is used when there is a serious impact that requires plenty of warning.) | |||
:* In the third stage, the material is removed, and replaced by this pragma, which points to a previous version of the documentation to find it. All links to the page are removed. (That way, browsing and searching doesn't surface old material, but bookmarks will still work.) | |||
:* In final stage, the page is removed entirely. (Generally when it surfaces in some sort of clean up process.) | |||
</noinclude> | </noinclude> | ||
Latest revision as of 20:17, 20 March 2014
For information on this deprecated functionality, see the version {{{1}}} platform documentation:
https://agileappscloud.info/{{{2}}}/index.php?title=Deprecated_page
- Usage
{{deprecated_page|{version}|{wiki}}}
- => "see the version {version} docs at .../{wiki}/{page with same name as current page}
This pragma is added in the third stage of the deprecation process:
- In the first stage, a Template:DeprecationPlanned note is added at the top of existing documentation. Users can still see it, but have a warning that it will be deprecated.
- In the second stage, Template:Deprecated note is added, saying that the feature has been deprecated. Most if not all of the links to the page are removed, making it harder to find. (Often, the process starts here. Deprecation planned is used when there is a serious impact that requires plenty of warning.)
- In the third stage, the material is removed, and replaced by this pragma, which points to a previous version of the documentation to find it. All links to the page are removed. (That way, browsing and searching doesn't surface old material, but bookmarks will still work.)
- In final stage, the page is removed entirely. (Generally when it surfaces in some sort of clean up process.)