AgileApps Support Wiki Pre Release

Difference between revisions of "Template:Deprecated page"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 5: Line 5:
----
----
;Usage:
;Usage:
:* This pragma is added as the second stage of the deprecation process.
:* In the first stage, a [[Template:Deprecated]] note is added at the top of existing documentation. Users can still see it, but have a warning that it is deprecated.
:* In the second stage, the material is removed, and replaced by this pragma, which points to a previous version of the documentation to find it. (That way, users who are searching for information in the Wiki won't find themselves stumbling over old material.)
:* In stage 3, the page is removed entirely. (Nothing has gone to category 3, as yet.)
<blockquote>
<blockquote>
<tt><nowiki>{{deprecated_page|8.0|80}}</nowiki></tt>
<tt><nowiki>{{deprecated_page|{version}|{wiki}}}</nowiki></tt>
&nbsp; &nbsp; => "see the version 8.0 docs at .../lj80/...(page with same name as current page)
&nbsp; &nbsp; => "see the version {version} docs at .../{wiki}/...(page with same name as current page)
</blockquote>
</blockquote>
The full process is this:
:* This pragma is added in the third stage of the deprecation process.
:* In the first stage, a [[Template:Deprecation Planned]] 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. (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. (That way, searches won't surface old material, but bookmarks will still work.)
:* In final stage, the page is removed entirely.
</noinclude>
</noinclude>

Revision as of 20:12, 20 March 2014

For information on this deprecated functionality, see the version {{{1}}} platform docs:
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)

The full process is this:

  • This pragma is added in the third stage of the deprecation process.
  • In the first stage, a Template:Deprecation Planned 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. (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. (That way, searches won't surface old material, but bookmarks will still work.)
  • In final stage, the page is removed entirely.