s1kd-upissue(1)                   s1kd-tools                   s1kd-upissue(1)

NAME
       s1kd-upissue - Upissue S1000D data

SYNOPSIS
              s1kd-upissue [-045defilmNQqRsuvw^] [-1 <type>] [-2 <type>]
                           [-c <reason> [-H] [-t <urt>]]
                           [-I <date>] [-z <type>] [<file> ...]

DESCRIPTION
       The  s1kd-upissue  tool  increases  the  in-work  or issue number of an
       S1000D CSDB object.

       Any files using an S1000D-esque naming convention,  placing  the  issue
       and  in-work numbers after the first underscore (_) character, can also
       be "upissued".  Files which do not contain the appropriate S1000D meta‐
       data are simply copied.

OPTIONS
       -0, --unverified
              Set the quality assurance to unverified.

       -1, --first-ver <type>
              Set first verification type (tabtop, onobject, ttandoo).  If the
              object is second verified and this option is  specified  without
              -2 (--second-ver), the second verification will be unset.

       -2, --second-ver <type>
              Set  second  verification  type (tabtop, onobject, ttandoo).  If
              the object is unverified and this option is specified without -1
              (--first-ver),  the  first  verification will be set as the same
              type as the second verification.

       -4, --remove-marks
              Remove change markup on elements, but not RFUs, in the  upissued
              object.  This is automatically applied if the issue type (-z) is
              not "changed" or "rinstate-changed".

       -5, --print
              Print the file names of upissued objects.

       -c, --reason <reason>
              Add a reason for update to the upissued objects.  Multiple  RFUs
              can be added by specifying this option multiple times.

       -d, --dry-run
              Do not actually create or modify any files.

       -e, --erase
              Remove old issue file after upissuing.

       -f, --overwrite
              Overwrite existing upissued CSDB objects.

       -H, --highlight
              Mark the last specified reason for update (-c) as a highlight.

       -h, -?, --help
              Show help/usage message.

       -I, --date <date>
              Specify  the issue date to use for the upissued object(s).  Oth‐
              erwise, the current date will be used.

       -i, --official
              Increase the issue number of the CSDB object.  By  default,  the
              in-work issue is increased.

       -l, --list
              Treat  input  (stdin  or  arguments) as lists of CSDB objects to
              upissue, rather than CSDB objects themselves.

       -m, --modify
              Modify issue-related metadata on  objects  without  incrementing
              the issue or inwork numbers.  The -I and -r options have the op‐
              posite effect in this mode.  The modified objects are written to
              stdout  by default, and the -f option can be used to change them
              in-place.

       -N, --omit-issue
              Omit issue/inwork numbers from filename.

       -Q, --keep-qa
              Keep quality assurance information from  old  issue.   Normally,
              when  upissuing an official CSDB object to the first in-work is‐
              sue, the quality assurance is set back to "unverified".  Specify
              this option to indicate the upissue will not affect the contents
              of the CSDB object, and so does not require it  to  be  re-veri‐
              fied.

       -q, --quiet
              Quiet mode.  Errors are not printed.

       -R, --keep-unassoc-marks
              Delete only change markup on elements associated with an RFU (by
              use of the attribute reasonForUpdateRefIds).  Change  markup  on
              other elements is ignored.

       -r, --(keep|remove)-changes
              Keep  old  RFUs  and  change marks.  Normally, when upissuing an
              offical CSDB object to the first in-work issue, any reasons  for
              update  are  deleted automatically, along with any change markup
              attributes on elements (when change type is "add"  or  "modify")
              or the elements themselves (when change type is "delete").  This
              option prevents their deletion.

              In -m mode, this option has the  opposite  effect,  causing  the
              current  RFUs  and change marks to be removed.  The two alterna‐
              tive long option names, --keep-changes and --remove-changes, al‐
              low  for  the  intended  meaning  of this option to be expressed
              clearly in each mode.

       -s, --(keep|change)-date
              Do not change issue date.  Normally, when upissuing to the  next
              inwork  or official issue, the issue date is changed to the cur‐
              rent date, or the date specified with the -z option.   This  op‐
              tion  will  keep the date of the previous inwork or official is‐
              sue.

              In -m mode, this option has the  opposite  effect,  causing  the
              date  to  be  changed.   The  two alternative long option names,
              --keep-date and --change-date, allow for the intended meaning of
              this option to be expressed clearly in each mode.

       -t, --type <urt>
              Set the updateReasonType of the last specified reason for update
              (-c).

       -u, --clean-rfus
              Remove RFUs which are not associated with any change markup  (by
              use of the attribute reasonForUpdateRefIds).

       -v, --verbose
              Verbose output.

       -w, --lock
              Make the old issue file read-only after upissuing.  Official is‐
              sues (-i) will also be made read-only when they are created.

       -z, --issue-type <type>
              Set the issue type of the new issue.

              If this option is not specified, then the issue type of the  new
              issue will be set as follows:

              · if  the  previous issue is not an official issue (in-work 00),
                the issue type of the new issue will be the same as the previ‐
                ous issue.

              · if  the previous issue is an official issue, the issue type of
                the new issue will default to "status".

       -^, --remove-deleted
              Remove elements with change type of  "delete".   These  elements
              are  automatically  removed along with all change marks and RFUs
              when an object is upissued from official to the next inwork  is‐
              sue.  This option will remove them when upissuing between inwork
              issues, or when making the object official.

       --version
              Show version information.

       <file>...
              Any number of CSDB objects or other files to upissue.   If  none
              are  specified, the object will be read from stdin and the upis‐
              sued object will be written to stdout.

       In addition, the following options allow configuration of the XML pars‐
       er:

       --dtdload
              Load the external DTD.

       --huge Remove any internal arbitrary parser limits.

       --net  Allow network access to load external DTD and entities.

       --noent
              Resolve entities.

       --parser-errors
              Emit errors from parser.

       --parser-warnings
              Emit warnings from parser.

       --xinclude
              Do XInclude processing.

       --xml-catalog <file>
              Use  an  XML catalog when resolving entities.  Multiple catalogs
              may be loaded by specifying this option multiple times.

EXAMPLES
   Data module with issue/inwork in filename
              $ ls
              DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_000-01_EN-CA.XML

              $ s1kd-upissue DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_000-01_EN-CA.XML
              $ ls
              DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_000-01_EN-CA.XML
              DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_000-02_EN-CA.XML

              $ s1kd-upissue \
                -i DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_000-02_EN-CA.XML
              $ ls
              DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_000-01_EN-CA.XML
              DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_000-02_EN-CA.XML
              DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_001-00_EN-CA.XML

   Data module without issue/inwork in filename
              $ ls
              DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_EN-US.XML

              $ s1kd-metadata DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_EN-CA.XML \
                -n issueInfo
              000-01
              $ s1kd-upissue -N DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_EN-CA.XML
              $ s1kd-metadata DMC-S1KDTOOLS-A-00-00-00-00A-040A-D_EN-CA.XML \
                -n issueInfo
              000-02

   Non-XML file with issue/inwork in filename
              $ ls
              TXT-S1KDTOOLS-KHZAE-FOOBAR_000-01_EN-CA.TXT

              $ s1kd-upissue TXT-S1KDTOOLS-KHZAE-00001_000-01_EN-CA.TXT
              $ ls
              TXT-S1KDTOOLS-KHZAE-FOOBAR_000-01_EN-CA.TXT
              TXT-S1KDTOOLS-KHZAE-FOOBAR_000-02_EN-CA.TXT

AUTHORS
       khzae.net.

                                  2021-04-16                   s1kd-upissue(1)