[
https://issues.apache.org/jira/browse/DERBY-4851?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Rick Hillegas updated DERBY-4851:
---------------------------------
Attachment: derby-4851-01-aa-copyrightYear.diff
Attaching derby-4851-01-aa-copyrightYear.diff. This patch introduces the basic
machinery for parameterizing the release variables in the user docs. In
addition, this patch applies that machinery to the copyright year. Committed at
subversion revision 1023023.
To change the copyright year in the user guides, all you have to do now is
change the value of the copyright.year variable in docs.properties.
It's probably a good idea to keep this variable up-to-date. However, later on I
am going to modify the master release-build target so that copyright.year is
overridden by the current year. This will result in correct copyright years
even if we forget to modify docs.properties.
This patch makes the following changes:
1) Introduces the copyright.year ant property.
2) Modifies the doc sources, replacing the literal "2010" strings with the ant
token "@COPYRIGHT_YEAR@".
3) Adds a pre-processing step to the docs build. In this preprocessing step,
the sources are copied to a temp directory rooted at temp_source and
@COPYRIGHT_YEAR@ literals are replaced with the value of copyright.year.
Touches the following files:
-------------
M .
Makes svn ignore the new temp_source directory.
-------------
M docs.properties
Adds a new copyright.year property, initially set to be 2010.
-------------
M src/tools/derbytools.ditamap
M src/tools/rtoolscopyright.dita
M src/tuning/rtuncopyright.dita
M src/tuning/tuningderby.ditamap
M src/adminguide/derbyadmin.ditamap
M src/adminguide/radmincopyright.dita
M src/devguide/derbydev.ditamap
M src/devguide/rdevcopyright.dita
M src/ref/rrefcopyright.dita
M src/ref/refderby.ditamap
M src/getstart/rgscopyright.dita
M src/getstart/getstartderby.ditamap
Replaces the copyright end-years with the @COPYRIGHT_YEAR@ literal.
-------------
M build.xml
Adds the new preprocessing step.
> Parameterize documentation sources so that release-time variables (like
> copyright year and release id) can be plugged in when we build a release
> ------------------------------------------------------------------------------------------------------------------------------------------------
>
> Key: DERBY-4851
> URL: https://issues.apache.org/jira/browse/DERBY-4851
> Project: Derby
> Issue Type: Improvement
> Components: Documentation
> Reporter: Rick Hillegas
> Assignee: Rick Hillegas
> Attachments: derby-4851-01-aa-copyrightYear.diff
>
>
> Right now there are a number of strings which have to be updated in the user
> guides every time that we cut a branch or generate a release candidate. We
> should parameterize these strings so that the build script can fill them in.
> Probably we will have to use the ant substitution task for this because there
> is no obvious way to do this via DITA.
> These are the variables I am aware of. Please let me know if there are others:
> Latest copyright year (currently 2010)
> 2 part version number (e.g., 10.7) (this is plugged into the ij script
> output, among other uses)
> 4 part version number (e.g. 10.7.1.0)
> subversion revision number (e.g. 1000400)
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
