Deprecating a Token - Revision history

Tom Parker at 22:59, 7 March 2014

2014-03-07T22:59:48Z

Tom Parker at 02:41, 7 March 2014

2014-03-07T02:41:34Z

Karianna at 09:59, 27 April 2010

2010-04-27T09:59:32Z

Karianna: /* Steps */

2008-09-24T12:21:15Z

‎Steps

Karianna: /* Steps */

2008-09-24T12:20:55Z

‎Steps

Karianna: /* Steps */

2008-09-24T12:20:21Z

‎Steps

Karianna: New page: {| align="right" | TOC |} =Introduction= We have a formal method around removing tokens, the first step being to deprecate them for the next major release cycle. e.g. If the cur...

2008-09-24T12:16:13Z

New page: {| align="right" | __TOC__ |} =Introduction= We have a formal method around removing tokens, the first step being to deprecate them for the next major release cycle. e.g. If the cur...

New page

{| align="right"
| __TOC__
|}

=Introduction=
We have a formal method around removing tokens, the first step being to deprecate them for the next major release cycle. e.g. If the current PCGen version is 5.14.2 then we can deprecate a token for the 5.16.x line and perform the actual removal in the 6.0.x line.

=Steps=

# Move the token in the build script so that it is built in the deprecated tokens area, e.g.
[http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/pluginbuild.xml?r1=7022&r2=7021&pathrev=7022 example]

@@ Line 14: / Line 14: @@
 ## You will need to update to the new package (above)
 ## You will need to specifically name the new JAR: ???-DEPRECATED-YYY where YYY is the prefix (everything in the class name except the trailing "Lst" or "Token" - this is case insensitive) [This is required due to our plugin build checking]
 # Edit the deprecated token
 ## Make the token implement the DeprecatedToken interface.

@@ Line 8: / Line 8: @@
 =Steps=
-# Move the token in the build script so that it is built in the deprecated tokens area, e.g. [http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/pluginbuild.xml?r1=7022&r2=7021&pathrev=7022 example]
+# Ensure you have approval for the token change via the [[New_.lst_Tag_process]].  The token should have gone through a NEWTAG proposal ( http://jira.pcgen.org/browse/NEWTAG ) and discussion on the pcgen_experimental list ( https://groups.yahoo.com/neo/groups/pcgen_experimental/conversations/messages )
-# SVN Move the java source file, e.g. <br/>
+# SVN Move the token itself to the plugin.lsttokens.deprecated package (e.g. '''FROM''' branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/template/BonusfeatsToken.java '''TO''' pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java
-'''FROM''' <br/>
+# Move the location of the JAR/Plugin build in the pluginbuild.xml file (this can be found in the code folder of our build).  The proper location in the file is in the section "jar-deprecated-plugin"
-branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/template/BonusfeatsToken.java <br/>
+## Move the item to a different location in the XML
-'''TO''' <br/>
+## You will need to update to the new package (above)
-pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java
+## You will need to specifically name the new JAR: ???-DEPRECATED-YYY where YYY is the prefix (everything in the class name except the trailing "Lst" or "Token" - this is case insensitive) [This is required due to our plugin build checking]
-# Edit the deprecated token e.g. Like [http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java?r1=7022&r2=7017&pathrev=7022 this].
+# Edit the deprecated token
-# Open a Doc Issue to set that token to be deprecated.
+## Make the token implement the DeprecatedToken interface.
-# Open Data Issue so that people convert from the old token to the new token.
+## If there is a known replacement token, then ensure that the contents loaded into the rules context in parse represents the load config of the replacement token
-# Open a PrettyLst Issue so that the token can be put into the correct area for warnings etc.
+## If there is a known replacement token, then have the Deprecated token implement CDOMCompatibilityToken RATHER THAN CDOMPrimaryToken or CDOMSecondaryToken.  Note that this may require some special changes if the item was previously a secondary token, as CDOMCompatibilityToken is a primary token.

@@ Line 15: / Line 15: @@
 pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java
 # Edit the deprecated token e.g. Like [http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java?r1=7022&r2=7017&pathrev=7022 this].
-# Open a Doc tracker to set that token to be deprecated.
+# Open a Doc Issue to set that token to be deprecated.
-# Open Data Tracker so that people convert from the old token to the new token.
+# Open Data Issue so that people convert from the old token to the new token.
-# Open a PrettyLst tracker so that the token can be put into the correct area for warnings etc.
+# Open a PrettyLst Issue so that the token can be put into the correct area for warnings etc.

@@ Line 9: / Line 9: @@
 # Move the token in the build script so that it is built in the deprecated tokens area, e.g. [http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/pluginbuild.xml?r1=7022&r2=7021&pathrev=7022 example]
-# SVN Move the java source file, e.g. FROM <br/>
+# SVN Move the java source file, e.g. <br/>
 branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/template/BonusfeatsToken.java <br/>
-TO <br/>
+'''TO''' <br/>
 pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java
 # Edit the deprecated token e.g. Like [http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java?r1=7022&r2=7017&pathrev=7022 this].

@@ Line 9: / Line 9: @@
 # Move the token in the build script so that it is built in the deprecated tokens area, e.g. [http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/pluginbuild.xml?r1=7022&r2=7021&pathrev=7022 example]
-# SVN Move the java source file, e.g. FROM branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/template/BonusfeatsToken.java TO pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java
+# SVN Move the java source file, e.g. FROM <br/>
 # Edit the deprecated token e.g. Like [http://pcgen.svn.sourceforge.net/viewvc/pcgen/branches/5.14.x/pcgen/code/src/java/plugin/lsttokens/deprecated/BonusfeatsToken.java?r1=7022&r2=7017&pathrev=7022 this].
 # Open a Doc tracker to set that token to be deprecated.
 # Open Data Tracker so that people convert from the old token to the new token.
 # Open a PrettyLst tracker so that the token can be put into the correct area for warnings etc.

Deprecating a Token - Revision history

Tom Parker at 22:59, 7 March 2014

Tom Parker at 02:41, 7 March 2014

Karianna at 09:59, 27 April 2010

Karianna: /* Steps */

Karianna: /* Steps */

Karianna: /* Steps */

Karianna: New page: {| align="right" | __TOC__ |} =Introduction= We have a formal method around removing tokens, the first step being to deprecate them for the next major release cycle. e.g. If the cur...

Karianna: New page: {| align="right" | TOC |} =Introduction= We have a formal method around removing tokens, the first step being to deprecate them for the next major release cycle. e.g. If the cur...