Derby
  1. Derby
  2. DERBY-4547

Documentation: update copyright, version to 2010 and 10.6

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 10.6.1.0
    • Fix Version/s: 10.6.1.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      The copyright and map files for each book need to be updated in the trunk. In addition, examples that currently use 10.5 should be updated to use 10.6.

      1. DERBY-4547.diff
        36 kB
        Kim Haase
      2. DERBY-4547.stat
        1 kB
        Kim Haase
      3. DERBY-4547.zip
        56 kB
        Kim Haase

        Issue Links

          Activity

          Hide
          Kim Haase added a comment -

          Attaching DERBY-4547.diff, DERBY-4547.stat, and DERBY-4547.zip, with the following changes:

          Changed version number to 10.6
          Changed copyright date to 2010
          Changed command output to show 10.6
          Changed java -version output to show 1.6 instead of 1.4 (one file)
          Changed some Java references to use current terminology (two files)
          A few formatting fixes

          This touches the following files:

          src/conrefs.dita
          all 6 ditamap files
          all 6 copyright files

          And also these:

          Developer's Guide:
          src/devguide/cdevdvlp27715.dita
          src/devguide/tdevdvlp20349.dita

          Getting Started:
          src/getstart/tgssetupverify.dita (updated java -version output)
          src/getstart/twwdactivity1.dita
          src/getstart/twwdactivity3_Setup.dita
          src/getstart/rgsdocs17307.dita (missing space, Java Platform reference)
          src/getstart/twwdactivity2.dita
          src/getstart/twwdactivity4.dita
          src/getstart/cgsintsr.dita (Java, JDK references)
          src/getstart/rgslib46043.dita (library out of alphabetical order)

          Tools:
          src/tools/rtoolssysinfo1002629.dita

          In addition, I discovered that several source files had somehow acquired an A-tilde followed by a space where the source had " ". I fixed these either by replacing the " " with an actual space (where it occurred in a codeblock) or by reinserting the " ". This involved changes to the following files:

          src/getstart/tgsrunningsysinfo.dita
          src/getstart/tgsrunningij.dita
          src/getstart/cwwdsummary.dita
          src/getstart/tgsrunningdblook.dita
          src/ref/rrefsqlj81859.dita
          src/tuning/ctunoptimzoverride.dita

          The   problem should perhaps be a separate issue, but I found it while combing through Getting Started for the version fixes. There's also a catch-22 with it, because inserting the   results in correct output for all 3 output doc types (PDF, HTML-single, and HTML frames) if I build the docs on my Windows system; but if I build them on my UNIX system, the HTML frames output contains two question marks ("??") instead of a space. In my Firefox browser, anyway. The Latest Alpha Manuals output shows this problem – maybe it was built on a UNIX system too? See, for instance, http://db.apache.org/derby/docs/dev/getstart/cwwdactivities.html. (The   and the A-tilde followed by a space both result in the same question-mark output, actually.)

          The   tags are needed because the DITA toolkit fails to preserve white space between adjacent tags in body text (for example, between a <ph></ph> and a <codeph></codeph> in the PDF and HTML-single output (though it preserves them in the HTML frames output). See the discussion at the end of DERBY-408 for details.

          Show
          Kim Haase added a comment - Attaching DERBY-4547 .diff, DERBY-4547 .stat, and DERBY-4547 .zip, with the following changes: Changed version number to 10.6 Changed copyright date to 2010 Changed command output to show 10.6 Changed java -version output to show 1.6 instead of 1.4 (one file) Changed some Java references to use current terminology (two files) A few formatting fixes This touches the following files: src/conrefs.dita all 6 ditamap files all 6 copyright files And also these: Developer's Guide: src/devguide/cdevdvlp27715.dita src/devguide/tdevdvlp20349.dita Getting Started: src/getstart/tgssetupverify.dita (updated java -version output) src/getstart/twwdactivity1.dita src/getstart/twwdactivity3_Setup.dita src/getstart/rgsdocs17307.dita (missing space, Java Platform reference) src/getstart/twwdactivity2.dita src/getstart/twwdactivity4.dita src/getstart/cgsintsr.dita (Java, JDK references) src/getstart/rgslib46043.dita (library out of alphabetical order) Tools: src/tools/rtoolssysinfo1002629.dita In addition, I discovered that several source files had somehow acquired an A-tilde followed by a space where the source had " ". I fixed these either by replacing the " " with an actual space (where it occurred in a codeblock) or by reinserting the " ". This involved changes to the following files: src/getstart/tgsrunningsysinfo.dita src/getstart/tgsrunningij.dita src/getstart/cwwdsummary.dita src/getstart/tgsrunningdblook.dita src/ref/rrefsqlj81859.dita src/tuning/ctunoptimzoverride.dita The   problem should perhaps be a separate issue, but I found it while combing through Getting Started for the version fixes. There's also a catch-22 with it, because inserting the   results in correct output for all 3 output doc types (PDF, HTML-single, and HTML frames) if I build the docs on my Windows system; but if I build them on my UNIX system, the HTML frames output contains two question marks ("??") instead of a space. In my Firefox browser, anyway. The Latest Alpha Manuals output shows this problem – maybe it was built on a UNIX system too? See, for instance, http://db.apache.org/derby/docs/dev/getstart/cwwdactivities.html . (The   and the A-tilde followed by a space both result in the same question-mark output, actually.) The   tags are needed because the DITA toolkit fails to preserve white space between adjacent tags in body text (for example, between a <ph></ph> and a <codeph></codeph> in the PDF and HTML-single output (though it preserves them in the HTML frames output). See the discussion at the end of DERBY-408 for details.
          Hide
          Kim Haase added a comment -

          I'll commit this patch on Friday 2/19 if there are no comments by then.

          Show
          Kim Haase added a comment - I'll commit this patch on Friday 2/19 if there are no comments by then.
          Hide
          Knut Anders Hatlen added a comment -

          Hi Kim,

          The patch looks fine to me. Do we have to change the references to 10.6.0.0 - (908506) to point to the actual release when that's ready? I don't remember how we've handled that before.

          Anyways, +1 to commit.

          Show
          Knut Anders Hatlen added a comment - Hi Kim, The patch looks fine to me. Do we have to change the references to 10.6.0.0 - (908506) to point to the actual release when that's ready? I don't remember how we've handled that before. Anyways, +1 to commit.
          Hide
          Knut Anders Hatlen added a comment -

          As to the question marks, I see that too if I build the docs with locale set to C or en_US.ISO8859-1. The docs look fine if I build with locale set to en_US.UTF-8. Perhaps we should file a separate JIRA to see if we can fix this?

          Show
          Knut Anders Hatlen added a comment - As to the question marks, I see that too if I build the docs with locale set to C or en_US.ISO8859-1. The docs look fine if I build with locale set to en_US.UTF-8. Perhaps we should file a separate JIRA to see if we can fix this?
          Hide
          Kim Haase added a comment -

          Oh my gosh! That is so simple!! All I have to do is (in my C shell)

          setenv LANG en_US.UTF-8

          And the question marks no longer appear in the processed docs! I think this just needs to be added to http://db.apache.org/derby/manuals/dita.html – which needs some additional updates anyway. Unfortunately I don't currently have access to that source or know how to process it (I think it involves Forrest, Maven, etc.?).

          But I'll file a JIRA asking for those instructions to be included.

          In answer to your question, yes, we should change the references to 10.6.0.0 - (908506) to point to the actual release – but that usually happens after the release and shows up in the Alpha manuals thereafter. Mainly because we don't know the actual release number and build until after the final docs are built.

          Thanks very much, Knut, for the okay and for the information!

          Show
          Kim Haase added a comment - Oh my gosh! That is so simple!! All I have to do is (in my C shell) setenv LANG en_US.UTF-8 And the question marks no longer appear in the processed docs! I think this just needs to be added to http://db.apache.org/derby/manuals/dita.html – which needs some additional updates anyway. Unfortunately I don't currently have access to that source or know how to process it (I think it involves Forrest, Maven, etc.?). But I'll file a JIRA asking for those instructions to be included. In answer to your question, yes, we should change the references to 10.6.0.0 - (908506) to point to the actual release – but that usually happens after the release and shows up in the Alpha manuals thereafter. Mainly because we don't know the actual release number and build until after the final docs are built. Thanks very much, Knut, for the okay and for the information!
          Hide
          Kim Haase added a comment -

          Thanks for the review and help, Knut.

          Committed patch DERBY-4547.diff to documentation trunk at revision 911444.

          Show
          Kim Haase added a comment - Thanks for the review and help, Knut. Committed patch DERBY-4547 .diff to documentation trunk at revision 911444.
          Hide
          Kim Haase added a comment -

          Changes have appeared in Latest Alpha Manuals, so closing.

          Show
          Kim Haase added a comment - Changes have appeared in Latest Alpha Manuals, so closing.

            People

            • Assignee:
              Kim Haase
              Reporter:
              Kim Haase
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development