Details

    • Type: Sub-task Sub-task
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 10.8.2.2, 10.9.1.0
    • Fix Version/s: 10.9.1.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      Currently we provide table summaries by putting the table caption in the summary. However, the <desc> element should be used for this purpose.

      1. crefproper22250.html
        33 kB
        Kim Haase
      2. DERBY-5640-9.diff
        0.6 kB
        Kim Haase
      3. rrefexcept71493.dita
        327 kB
        Rick Hillegas
      4. derby-5640-01-aa-messageBuilder.diff
        0.6 kB
        Rick Hillegas
      5. DERBY-5640-8.zip
        72 kB
        Kim Haase
      6. DERBY-5640-8.stat
        1 kB
        Kim Haase
      7. DERBY-5640-8.diff
        20 kB
        Kim Haase
      8. DERBY-5640-7.zip
        57 kB
        Kim Haase
      9. DERBY-5640-7.stat
        0.6 kB
        Kim Haase
      10. DERBY-5640-7.diff
        22 kB
        Kim Haase
      11. DERBY-5640-6.zip
        16 kB
        Kim Haase
      12. DERBY-5640-6.stat
        0.3 kB
        Kim Haase
      13. DERBY-5640-6.diff
        5 kB
        Kim Haase
      14. DERBY-5640-5.zip
        32 kB
        Kim Haase
      15. DERBY-5640-5.stat
        0.5 kB
        Kim Haase
      16. DERBY-5640-5.diff
        8 kB
        Kim Haase
      17. DERBY-5640-4.zip
        28 kB
        Kim Haase
      18. DERBY-5640-4.stat
        0.4 kB
        Kim Haase
      19. DERBY-5640-4.diff
        7 kB
        Kim Haase
      20. DERBY-5640-3.zip
        10 kB
        Kim Haase
      21. DERBY-5640-3.stat
        0.2 kB
        Kim Haase
      22. DERBY-5640-3.diff
        3 kB
        Kim Haase
      23. DERBY-5640-2.zip
        9 kB
        Kim Haase
      24. DERBY-5640-2.stat
        0.6 kB
        Kim Haase
      25. DERBY-5640-2.diff
        37 kB
        Kim Haase
      26. DERBY-5640.zip
        8 kB
        Kim Haase
      27. DERBY-5640.stat
        0.1 kB
        Kim Haase
      28. DERBY-5640.diff
        6 kB
        Kim Haase

        Issue Links

          Activity

          Hide
          Kim Haase added a comment -

          To use the <desc> element for the table caption requires a change to dita2htmlImpl.xsl that modifies what was done for DERBY-5255. Instead of placing the contents of the <desc> element in the table caption, the dita2htmlImpl.xsl processing places them in the summary attribute of the table element. If no <desc> element is present, the caption is placed in the summary as before.

          Will attach patched for xsl file and sample output in due course.

          Show
          Kim Haase added a comment - To use the <desc> element for the table caption requires a change to dita2htmlImpl.xsl that modifies what was done for DERBY-5255 . Instead of placing the contents of the <desc> element in the table caption, the dita2htmlImpl.xsl processing places them in the summary attribute of the table element. If no <desc> element is present, the caption is placed in the summary as before. Will attach patched for xsl file and sample output in due course.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-5640.diff, DERBY-5640.stat, and DERBY-5640.zip, with changes to the XSL file and to the first two topics in Getting Started that have tables:

          M lib/dita2htmlImpl.xsl
          M src/getstart/tgssetupjavaenvir.dita
          M src/getstart/tgsruntoolsutils.dita

          The zip file contains three files: two containing the output of the modified topics, with the <desc> content in the table summary, and the other showing that for an unmodified file, the contents of the table title/caption are in the summary.

          Show
          Kim Haase added a comment - Attaching DERBY-5640 .diff, DERBY-5640 .stat, and DERBY-5640 .zip, with changes to the XSL file and to the first two topics in Getting Started that have tables: M lib/dita2htmlImpl.xsl M src/getstart/tgssetupjavaenvir.dita M src/getstart/tgsruntoolsutils.dita The zip file contains three files: two containing the output of the modified topics, with the <desc> content in the table summary, and the other showing that for an unmodified file, the contents of the table title/caption are in the summary.
          Hide
          Kim Haase added a comment -

          I plan to commit this patch in the next day or two unless I hear that changes are needed. I'll work on adding <desc> elements to tables gradually over the next few weeks.

          Show
          Kim Haase added a comment - I plan to commit this patch in the next day or two unless I hear that changes are needed. I'll work on adding <desc> elements to tables gradually over the next few weeks.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-5640.diff to documentation trunk at revisions 1298137 and 1298138.

          Will provide additional patches to add <desc> elements for other tables.

          Show
          Kim Haase added a comment - Committed patch DERBY-5640 .diff to documentation trunk at revisions 1298137 and 1298138. Will provide additional patches to add <desc> elements for other tables.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-5640-2.diff, DERBY-5640-2.stat, and DERBY-5640-2.zip, with the remaining changes to the Getting Started manual, and an additional change to the build setup to prevent the table descriptions from appearing in the PDF output:

          M src/getstart/tgssetupverify.dita
          M src/getstart/twwdactivity1.dita
          M src/getstart/twwdactivity3_Setup.dita
          M src/getstart/rgslib46043.dita
          M src/getstart/twwdactivity2.dita
          M src/getstart/tgsrunningsysinfo.dita
          M src/getstart/rgsdocs18277.dita
          M src/getstart/tgsrunningij.dita
          M src/getstart/rgsdocs10012.dita
          M src/getstart/twwdactivity1_Setup.dita
          M src/getstart/rgsderbyrunjarsyntax.dita
          M src/getstart/twwdactivity4.dita
          M src/getstart/tgsrunningdblook.dita
          M build.xml
          A lib/dita2fo-elems.xsl

          The change to the dita2fo-elems.xsl file means that no desc element appears in the PDF output. Although it is possible to put desc elements in a few locations other than tables, the Derby documentation does not use them anywhere else.

          Another minor change is that the existing version of the dita2fo-elems.xsl file is all on one line for some reason; this version has newlines for readability.

          The zip file contains only a small sample, not the output for every file with tables.

          I will check this in in a couple of days unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-5640 -2.diff, DERBY-5640 -2.stat, and DERBY-5640 -2.zip, with the remaining changes to the Getting Started manual, and an additional change to the build setup to prevent the table descriptions from appearing in the PDF output: M src/getstart/tgssetupverify.dita M src/getstart/twwdactivity1.dita M src/getstart/twwdactivity3_Setup.dita M src/getstart/rgslib46043.dita M src/getstart/twwdactivity2.dita M src/getstart/tgsrunningsysinfo.dita M src/getstart/rgsdocs18277.dita M src/getstart/tgsrunningij.dita M src/getstart/rgsdocs10012.dita M src/getstart/twwdactivity1_Setup.dita M src/getstart/rgsderbyrunjarsyntax.dita M src/getstart/twwdactivity4.dita M src/getstart/tgsrunningdblook.dita M build.xml A lib/dita2fo-elems.xsl The change to the dita2fo-elems.xsl file means that no desc element appears in the PDF output. Although it is possible to put desc elements in a few locations other than tables, the Derby documentation does not use them anywhere else. Another minor change is that the existing version of the dita2fo-elems.xsl file is all on one line for some reason; this version has newlines for readability. The zip file contains only a small sample, not the output for every file with tables. I will check this in in a couple of days unless I hear otherwise.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-5640-2.diff to documentation trunk at revision 1304540.

          Thanks to Raymond Gallardo of Oracle for making the fix to dita2fo-elems.xsl.

          Show
          Kim Haase added a comment - Committed patch DERBY-5640 -2.diff to documentation trunk at revision 1304540. Thanks to Raymond Gallardo of Oracle for making the fix to dita2fo-elems.xsl.
          Hide
          Kim Haase added a comment -

          The Tools guide has 5 tables in 4 topics. Attaching DERBY-5640-3.diff, DERBY-5640-3.stat, and DERBY-5640-3.zip:

          M src/tools/rtoolsplanexpxmlformat.dita
          M src/tools/rtoolsijlocale.dita
          M src/tools/rtoolsdrvrnmeurl.dita
          M src/tools/rtoolsijpropref97949.dita

          I will commit this in a couple of days unless I hear otherwise.

          Show
          Kim Haase added a comment - The Tools guide has 5 tables in 4 topics. Attaching DERBY-5640 -3.diff, DERBY-5640 -3.stat, and DERBY-5640 -3.zip: M src/tools/rtoolsplanexpxmlformat.dita M src/tools/rtoolsijlocale.dita M src/tools/rtoolsdrvrnmeurl.dita M src/tools/rtoolsijpropref97949.dita I will commit this in a couple of days unless I hear otherwise.
          Hide
          Myrna van Lunteren added a comment -

          Hi Kim,

          I had not noticed the commit comments indicating that you weren't the original contributor of the dita2fo-elems.xsl.
          It's good that you gave credit in the commit message where it was due, and wonderful of Raymond to help out.

          Still it's a little unusual to not hear from the contributor in person.
          Perhaps we can get a comment from Raymond indicating the contribution is officially granted to Apache?

          Myrna

          Show
          Myrna van Lunteren added a comment - Hi Kim, I had not noticed the commit comments indicating that you weren't the original contributor of the dita2fo-elems.xsl. It's good that you gave credit in the commit message where it was due, and wonderful of Raymond to help out. Still it's a little unusual to not hear from the contributor in person. Perhaps we can get a comment from Raymond indicating the contribution is officially granted to Apache? Myrna
          Hide
          Kim Haase added a comment -

          I guess my comment was a bit misleading. Raymond is a member of my documentation group at Oracle (we report to the same manager), and what he contributed was not the file itself, which is already part of the DITA Toolkit. He knows XSL well enough to be able to comment out the part of the file that put the contents of the <desc> element into the PDF. He actually provided the previous edits to the XSL files too – it all comes in under the Oracle documentation contribution. I wanted to make sure he got public credit for the work, since no current contributor seems to have enough XML/XSL knowledge to make Toolkit fixes.

          I will, however, write to him and ask him to make that comment. If he doesn't have an Apache JIRA login, I can add his reply.

          Show
          Kim Haase added a comment - I guess my comment was a bit misleading. Raymond is a member of my documentation group at Oracle (we report to the same manager), and what he contributed was not the file itself, which is already part of the DITA Toolkit. He knows XSL well enough to be able to comment out the part of the file that put the contents of the <desc> element into the PDF. He actually provided the previous edits to the XSL files too – it all comes in under the Oracle documentation contribution. I wanted to make sure he got public credit for the work, since no current contributor seems to have enough XML/XSL knowledge to make Toolkit fixes. I will, however, write to him and ask him to make that comment. If he doesn't have an Apache JIRA login, I can add his reply.
          Hide
          Rick Hillegas added a comment -

          Hi Kim and Myrna,

          Note that almost all of our message localizations are prepared by people who don't appear anywhere as Derby contributors. When we discussed this issue in the past, the conclusion was that these contributions are covered by the committer's ICLA. The committer asserts that he/she has the right to commit these contributions.

          Thanks,
          -Rick

          Show
          Rick Hillegas added a comment - Hi Kim and Myrna, Note that almost all of our message localizations are prepared by people who don't appear anywhere as Derby contributors. When we discussed this issue in the past, the conclusion was that these contributions are covered by the committer's ICLA. The committer asserts that he/she has the right to commit these contributions. Thanks, -Rick
          Hide
          Kim Haase added a comment -

          Thanks, Rick – I was wondering about that; I haven't written to Raymond yet. I do want to give credit to him for the work he has done (there may be more!), but there isn't any question about the authorization for the commit.

          Show
          Kim Haase added a comment - Thanks, Rick – I was wondering about that; I haven't written to Raymond yet. I do want to give credit to him for the work he has done (there may be more!), but there isn't any question about the authorization for the commit.
          Hide
          Myrna van Lunteren added a comment -

          Thanks for the clarification Rick, Kim. That's enough details/reassurance for me.

          Show
          Myrna van Lunteren added a comment - Thanks for the clarification Rick, Kim. That's enough details/reassurance for me.
          Hide
          Kim Haase added a comment -

          Still no commit message after half an hour or so, but I committed patch DERBY-5640-3.diff to documentation trunk at revision 1305614.

          Show
          Kim Haase added a comment - Still no commit message after half an hour or so, but I committed patch DERBY-5640 -3.diff to documentation trunk at revision 1305614.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-5640-4.diff, DERBY-5640-4.stat, and DERBY-5640-4.zip, with table descriptions for the Admin Guide (13 tables in 9 topics):

          M src/adminguide/tadmincbdjhhfd.dita
          M src/adminguide/cadminappsclienttracing.dita
          M src/adminguide/tadminimporting.dita
          M src/adminguide/tadminexporting.dita
          M src/adminguide/cadminappsclientsecurity.dita
          M src/adminguide/cadminreplicsecurity.dita
          M src/adminguide/radminappsresultsetdiffs.dita
          M src/adminguide/cadminreplicfailures.dita
          M src/adminguide/cadminappsclient.dita

          Will commit in a day or two unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-5640 -4.diff, DERBY-5640 -4.stat, and DERBY-5640 -4.zip, with table descriptions for the Admin Guide (13 tables in 9 topics): M src/adminguide/tadmincbdjhhfd.dita M src/adminguide/cadminappsclienttracing.dita M src/adminguide/tadminimporting.dita M src/adminguide/tadminexporting.dita M src/adminguide/cadminappsclientsecurity.dita M src/adminguide/cadminreplicsecurity.dita M src/adminguide/radminappsresultsetdiffs.dita M src/adminguide/cadminreplicfailures.dita M src/adminguide/cadminappsclient.dita Will commit in a day or two unless I hear otherwise.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-5640-4.diff to documentation trunk at revision 1306588.

          Show
          Kim Haase added a comment - Committed patch DERBY-5640 -4.diff to documentation trunk at revision 1306588.
          Hide
          Kim Haase added a comment -

          One of the Tuning manual topics with tables poses a terminology question, I think for Knut Anders.

          In the topic "Transaction-based lock escalation" (http://db.apache.org/derby/docs/10.8/tuning/ctunoptimz42065.html) each of the three tables has a column with the head "Promote?" The term "promote" or "promotion" is not used anywhere else in the Tuning manual, and the question being answered is whether the system will escalate to table-level locking. Is it okay if in addition to adding a description, I change the column head to "Escalate?"

          Thanks!

          Show
          Kim Haase added a comment - One of the Tuning manual topics with tables poses a terminology question, I think for Knut Anders. In the topic "Transaction-based lock escalation" ( http://db.apache.org/derby/docs/10.8/tuning/ctunoptimz42065.html ) each of the three tables has a column with the head "Promote?" The term "promote" or "promotion" is not used anywhere else in the Tuning manual, and the question being answered is whether the system will escalate to table-level locking. Is it okay if in addition to adding a description, I change the column head to "Escalate?" Thanks!
          Hide
          Kim Haase added a comment -

          The Developer's Guide has 14 tables in 12 topics, but I sneaked one fix (rdevcsecure557.dita) into DERBY-5522. Attaching DERBY-5640-5.diff, DERBY-5640-5.stat, and DERBY-5640-5.zip, with these changes:

          M src/devguide/rdevconcepts2462.dita
          M src/devguide/rdevconcepts8424.dita
          M src/devguide/cdevconcepts29416.dita
          M src/devguide/cdevspecialtfgetxxx.dita
          M src/devguide/cdevdvlp40724.dita
          M src/devguide/cdevconcepts15366.dita
          M src/devguide/cdevcollation.dita
          M src/devguide/tdevupgradedb.dita
          M src/devguide/rdevconcepts713.dita
          M src/devguide/rdevcsecure190.dita
          M src/devguide/cdevsetprop24843.dita

          I'll commit this in a day or so unless I hear otherwise.

          Show
          Kim Haase added a comment - The Developer's Guide has 14 tables in 12 topics, but I sneaked one fix (rdevcsecure557.dita) into DERBY-5522 . Attaching DERBY-5640 -5.diff, DERBY-5640 -5.stat, and DERBY-5640 -5.zip, with these changes: M src/devguide/rdevconcepts2462.dita M src/devguide/rdevconcepts8424.dita M src/devguide/cdevconcepts29416.dita M src/devguide/cdevspecialtfgetxxx.dita M src/devguide/cdevdvlp40724.dita M src/devguide/cdevconcepts15366.dita M src/devguide/cdevcollation.dita M src/devguide/tdevupgradedb.dita M src/devguide/rdevconcepts713.dita M src/devguide/rdevcsecure190.dita M src/devguide/cdevsetprop24843.dita I'll commit this in a day or so unless I hear otherwise.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-5640-6.diff, DERBY-5640-6.stat, and DERBY-5640-6.zip, with table descriptions for the 8 URL attribute and Derby limitations topics. Will commit soon unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-5640 -6.diff, DERBY-5640 -6.stat, and DERBY-5640 -6.zip, with table descriptions for the 8 URL attribute and Derby limitations topics. Will commit soon unless I hear otherwise.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-5640-5.diff to documentation trunk at revision 1309090 on 4/3/2012. (Sorry for the reporting delay.)

          Committed patch DERBY-5640-6.diff to documentation trunk at revision 1311217 on 4/9/2012.

          Show
          Kim Haase added a comment - Committed patch DERBY-5640 -5.diff to documentation trunk at revision 1309090 on 4/3/2012. (Sorry for the reporting delay.) Committed patch DERBY-5640 -6.diff to documentation trunk at revision 1311217 on 4/9/2012.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-5640-7.diff, DERBY-5640-7.stat, and DERBY-5640-7.zip, with changes to 48 tables in 18 files:

          M src/ref/rrefjavsqlprst.dita
          M src/ref/rrefjdbc20377.dita
          M src/ref/rrefjdbc23502.dita
          M src/ref/rrefjdbc27734.dita
          M src/ref/rrefjdbc38274.dita
          M src/ref/rrefjdbc40794.dita
          M src/ref/rrefjdbc75719.dita
          M src/ref/rrefjdbc96386.dita
          M src/ref/rrefsql9241891.dita
          M src/ref/rrefsqlj19433.dita
          M src/ref/rrefsqlj23075.dita
          M src/ref/rrefsqlj27767.dita
          M src/ref/rrefsqlj33562.dita
          M src/ref/rrefsqlj33923.dita
          M src/ref/rrefsqlj37836.dita
          M src/ref/rrefsqlj58560.dita
          M src/ref/rrefsqlj75638.dita
          M src/ref/rrefsqljargmatching.dita

          Will commit tomorrow unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-5640 -7.diff, DERBY-5640 -7.stat, and DERBY-5640 -7.zip, with changes to 48 tables in 18 files: M src/ref/rrefjavsqlprst.dita M src/ref/rrefjdbc20377.dita M src/ref/rrefjdbc23502.dita M src/ref/rrefjdbc27734.dita M src/ref/rrefjdbc38274.dita M src/ref/rrefjdbc40794.dita M src/ref/rrefjdbc75719.dita M src/ref/rrefjdbc96386.dita M src/ref/rrefsql9241891.dita M src/ref/rrefsqlj19433.dita M src/ref/rrefsqlj23075.dita M src/ref/rrefsqlj27767.dita M src/ref/rrefsqlj33562.dita M src/ref/rrefsqlj33923.dita M src/ref/rrefsqlj37836.dita M src/ref/rrefsqlj58560.dita M src/ref/rrefsqlj75638.dita M src/ref/rrefsqljargmatching.dita Will commit tomorrow unless I hear otherwise.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-5640-7.diff to documentation trunk at revision 1311726.

          Show
          Kim Haase added a comment - Committed patch DERBY-5640 -7.diff to documentation trunk at revision 1311726.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-5640-8.diff, DERBY-5640-8.stat, and DERBY-5640-8.zip, with changes to 30 tables in 29 files:

          M src/ref/rrefsysxplain_resultsets.dita
          M src/ref/rrefsysxplain_resultset_timings.dita
          M src/ref/rrefsysxplain_scan_props.dita
          M src/ref/rrefsysxplain_sort_props.dita
          M src/ref/rrefsysxplain_statements.dita
          M src/ref/rrefsysxplain_statement_timings.dita
          M src/ref/rrefsistabs12085.dita
          M src/ref/rrefsistabs12813.dita
          M src/ref/rrefsistabs13420.dita
          M src/ref/rrefsistabs22441.dita
          M src/ref/rrefsistabs23241.dita
          M src/ref/rrefsistabs24045.dita
          M src/ref/rrefsistabs24269.dita
          M src/ref/rrefsistabs26665.dita
          M src/ref/rrefsistabs28114.dita
          M src/ref/rrefsistabs33768.dita
          M src/ref/rrefsistabs33921.dita
          M src/ref/rrefsistabs39391.dita
          M src/ref/rrefsistabs40972.dita
          M src/ref/rrefsistabs79888.dita
          M src/ref/rrefsistabslilanguageitemsysstatistics.dita
          M src/ref/rrefsistabssyscolperms.dita
          M src/ref/rrefsistabssysperms.dita
          M src/ref/rrefsistabssysroles.dita
          M src/ref/rrefsistabssysroutineperms.dita
          M src/ref/rrefsistabssyssequences.dita
          M src/ref/rrefsistabssystableperms.dita
          M src/ref/rrefsistabssysusers.dita
          M src/ref/rrefsyscsdiagtables.dita

          Will commit tomorrow unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-5640 -8.diff, DERBY-5640 -8.stat, and DERBY-5640 -8.zip, with changes to 30 tables in 29 files: M src/ref/rrefsysxplain_resultsets.dita M src/ref/rrefsysxplain_resultset_timings.dita M src/ref/rrefsysxplain_scan_props.dita M src/ref/rrefsysxplain_sort_props.dita M src/ref/rrefsysxplain_statements.dita M src/ref/rrefsysxplain_statement_timings.dita M src/ref/rrefsistabs12085.dita M src/ref/rrefsistabs12813.dita M src/ref/rrefsistabs13420.dita M src/ref/rrefsistabs22441.dita M src/ref/rrefsistabs23241.dita M src/ref/rrefsistabs24045.dita M src/ref/rrefsistabs24269.dita M src/ref/rrefsistabs26665.dita M src/ref/rrefsistabs28114.dita M src/ref/rrefsistabs33768.dita M src/ref/rrefsistabs33921.dita M src/ref/rrefsistabs39391.dita M src/ref/rrefsistabs40972.dita M src/ref/rrefsistabs79888.dita M src/ref/rrefsistabslilanguageitemsysstatistics.dita M src/ref/rrefsistabssyscolperms.dita M src/ref/rrefsistabssysperms.dita M src/ref/rrefsistabssysroles.dita M src/ref/rrefsistabssysroutineperms.dita M src/ref/rrefsistabssyssequences.dita M src/ref/rrefsistabssystableperms.dita M src/ref/rrefsistabssysusers.dita M src/ref/rrefsyscsdiagtables.dita Will commit tomorrow unless I hear otherwise.
          Hide
          Kim Haase added a comment -

          The remaining tables in the Reference Manual are the ones for the generated file rrefexcept71493.dita, which is created anew for each release of Derby. I took a look at MessageBuilder.java and as best I can deduce, the best way to insert an appropriate <desc> element in each table is to insert something like the following code at line 516 – between the <title> and <tgroup> elements:

          ditaWriter.writeTextElement( "desc", "This table lists the SQLStates and message text for the " + title + "exceptions." );

          However, I'm not going to presume to do that. Rick, is this something you might be able to do? If so, thanks a million!

          Show
          Kim Haase added a comment - The remaining tables in the Reference Manual are the ones for the generated file rrefexcept71493.dita, which is created anew for each release of Derby. I took a look at MessageBuilder.java and as best I can deduce, the best way to insert an appropriate <desc> element in each table is to insert something like the following code at line 516 – between the <title> and <tgroup> elements: ditaWriter.writeTextElement( "desc", "This table lists the SQLStates and message text for the " + title + "exceptions." ); However, I'm not going to presume to do that. Rick, is this something you might be able to do? If so, thanks a million!
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-5640-8.diff to documentation trunk at revision 1327105.

          One additional reference manual topic is waiting for a DERBY-5442 commit before I can add the description.

          The "SQL error messages and exceptions" topic (rrefexcept71493.dita) requires a change to the MessageBuilder class that generates it.

          Show
          Kim Haase added a comment - Committed patch DERBY-5640 -8.diff to documentation trunk at revision 1327105. One additional reference manual topic is waiting for a DERBY-5442 commit before I can add the description. The "SQL error messages and exceptions" topic (rrefexcept71493.dita) requires a change to the MessageBuilder class that generates it.
          Hide
          Rick Hillegas added a comment -

          Your instincts about what to do with MessageBuilder sound right to me, Kim. Attaching derby-5640-01-aa-messageBuilder.diff, which does just what you said. Also attaching the corresponding output: rrefexcept71493.dita. Let me know if this looks right to you.

          Thanks,
          -Rick

          Show
          Rick Hillegas added a comment - Your instincts about what to do with MessageBuilder sound right to me, Kim. Attaching derby-5640-01-aa-messageBuilder.diff, which does just what you said. Also attaching the corresponding output: rrefexcept71493.dita. Let me know if this looks right to you. Thanks, -Rick
          Hide
          Kim Haase added a comment -

          Yes, thanks, Rick, the resulting rrefexcept71493.dita looks perfect and generates the right HTML output. Thanks so much. Do you want to commit that patch?

          Show
          Kim Haase added a comment - Yes, thanks, Rick, the resulting rrefexcept71493.dita looks perfect and generates the right HTML output. Thanks so much. Do you want to commit that patch?
          Hide
          Rick Hillegas added a comment -

          Thanks, Kim. I committed derby-5640-01-aa-messageBuilder.diff at subversion revision 1328359.

          Show
          Rick Hillegas added a comment - Thanks, Kim. I committed derby-5640-01-aa-messageBuilder.diff at subversion revision 1328359.
          Hide
          Kim Haase added a comment -

          Thanks so much, Rick, for making the MessageBuilder fix. That means that this patch, DERBY-5640-9.diff, is the last one, modifying the table in the "Derby properties" topic, crefproper22250.dita. I have attached the output file, crefproper22250.html.

          I'll commit this Monday.

          Show
          Kim Haase added a comment - Thanks so much, Rick, for making the MessageBuilder fix. That means that this patch, DERBY-5640 -9.diff, is the last one, modifying the table in the "Derby properties" topic, crefproper22250.dita. I have attached the output file, crefproper22250.html. I'll commit this Monday.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-5640-9.diff to documentation trunk at revision 1329348.

          Show
          Kim Haase added a comment - Committed patch DERBY-5640 -9.diff to documentation trunk at revision 1329348.
          Hide
          Kim Haase added a comment -

          Final changes have appeared in Latest Alpha Manuals.

          Show
          Kim Haase added a comment - Final changes have appeared in Latest Alpha Manuals.
          Hide
          Kim Haase added a comment -

          The desc elements were never added to the Tuning Guide – I seem to have lost track after posing the question on 3/28/2012 about lock escalation terminology. The Tuning Guide fixes (including the terminology one) are being made as part of DERBY-6379 instead.

          Show
          Kim Haase added a comment - The desc elements were never added to the Tuning Guide – I seem to have lost track after posing the question on 3/28/2012 about lock escalation terminology. The Tuning Guide fixes (including the terminology one) are being made as part of DERBY-6379 instead.

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Development