Details

    • Type: Sub-task Sub-task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 10.2.1.6, 10.3.1.4
    • Component/s: Documentation
    • Labels:
      None
    • Urgency:
      Urgent

      Description

      Need to add documentation for this new feature

      1. ShowViews.html
        1 kB
        David Van Couvering
      2. ShowTable.html
        2 kB
        David Van Couvering
      3. ShowSynonyms.html
        2 kB
        David Van Couvering
      4. ShowSchemas.html
        2 kB
        David Van Couvering
      5. ShowProcedures.html
        4 kB
        David Van Couvering
      6. Describe.html
        3 kB
        David Van Couvering
      7. derby-1659-views.diff
        1 kB
        Andrew McIntyre
      8. derby-1659-andrew-1-html.zip
        6 kB
        Andrew McIntyre
      9. derby-1659-andrew-1.diff
        17 kB
        Andrew McIntyre

        Activity

        Hide
        Kristian Waagan added a comment -

        Verified in alpha (10.3) and 10.2 doc builds.

        Show
        Kristian Waagan added a comment - Verified in alpha (10.3) and 10.2 doc builds.
        Hide
        Andrew McIntyre added a comment -

        Marking resolved, fixes in trunk and 10.2 branch.

        Show
        Andrew McIntyre added a comment - Marking resolved, fixes in trunk and 10.2 branch.
        Hide
        Jean T. Anderson added a comment -

        442496 merged to 10.2 branch revision 446722.
        448620 merged to 10.2 branch revision 449063.

        Show
        Jean T. Anderson added a comment - 442496 merged to 10.2 branch revision 446722. 448620 merged to 10.2 branch revision 449063.
        Hide
        Andrew McIntyre added a comment -

        Committed derby-1659-views to docs trunk with revision 448620.

        Show
        Andrew McIntyre added a comment - Committed derby-1659-views to docs trunk with revision 448620.
        Hide
        Andrew McIntyre added a comment -

        Attaching simple patch to include views in the reference for the new ij describe command.

        Show
        Andrew McIntyre added a comment - Attaching simple patch to include views in the reference for the new ij describe command.
        Hide
        Andreas Korneliussen added a comment -

        I have just a minor comment on the doc: I have been testing this feature, and found that descrbie also can be used for describing views.

        ij> show views;
        TABLE_SCHEM |TABLE_NAME |REMARKS
        ------------------------------------------------------------------------
        MYPP |V1 |

        1 row selected
        ij> describe mypp.v1;
        COLUMN_NAME |TYPE_NAME|DEC&|NUM&|COLUM&|COLUMN_DEF|CHAR_OCTE&|IS_NULL&
        ------------------------------------------------------------------------------
        C |INTEGER |0 |10 |10 |NULL |NULL |NO

        1 row selected

        Therefore, I propose that the doc is modified to say that it can describe views, and the syntax of the describe command could i.e be:
        describe <view_name>|<table_name>

        Show
        Andreas Korneliussen added a comment - I have just a minor comment on the doc: I have been testing this feature, and found that descrbie also can be used for describing views. ij> show views; TABLE_SCHEM |TABLE_NAME |REMARKS ------------------------------------------------------------------------ MYPP |V1 | 1 row selected ij> describe mypp.v1; COLUMN_NAME |TYPE_NAME|DEC&|NUM&|COLUM&|COLUMN_DEF|CHAR_OCTE&|IS_NULL& ------------------------------------------------------------------------------ C |INTEGER |0 |10 |10 |NULL |NULL |NO 1 row selected Therefore, I propose that the doc is modified to say that it can describe views, and the syntax of the describe command could i.e be: describe <view_name>|<table_name>
        Hide
        Andrew McIntyre added a comment -

        Marking FixIn 10.3 until this gets merged to 10.2 doc branch. Thanks for the review, Bryan!

        Show
        Andrew McIntyre added a comment - Marking FixIn 10.3 until this gets merged to 10.2 doc branch. Thanks for the review, Bryan!
        Hide
        Andrew McIntyre added a comment -

        Committed derby-1659-andrew-1 patch with revision 442496. Use of examples can be cleaned up in a followup patch. It would be helpful if someone else more familiar with DITA's use of <example>s could explain the benefit of having a single <example> per <reference>.

        Show
        Andrew McIntyre added a comment - Committed derby-1659-andrew-1 patch with revision 442496. Use of examples can be cleaned up in a followup patch. It would be helpful if someone else more familiar with DITA's use of <example>s could explain the benefit of having a single <example> per <reference>.
        Hide
        Bryan Pendleton added a comment -

        Andrew, I think you should mark this issue as assigned to you.

        David, the docs you wrote look great. Thanks!

        Andrew, I downloaded your diff and built the docs. They built fine, and the resulting HTML looks great.

        Note to the committed: there are two new files here that need "svn add" when committing:
        ? src/tools/rtoolsijcomrefshow.dita
        ? src/tools/rtoolsijcomrefdescribe.dita

        I do have one question, though. Why are some doc files named with "descriptive names" and
        some doc files named with "numeric names"? For example, in this change, we have:

        ? src/tools/rtoolsijcomrefshow.dita
        ? src/tools/rtoolsijcomrefdescribe.dita
        M src/tools/rtoolsijcomref17529.dita
        M src/tools/derbytools.ditamap
        M src/tools/rtoolsijcomref39198.dita

        I assume this is just a side issue with my lack of understanding of the DITA
        process. Aside from understanding this trivial detail, everything else looks great to me.

        Show
        Bryan Pendleton added a comment - Andrew, I think you should mark this issue as assigned to you. David, the docs you wrote look great. Thanks! Andrew, I downloaded your diff and built the docs. They built fine, and the resulting HTML looks great. Note to the committed: there are two new files here that need "svn add" when committing: ? src/tools/rtoolsijcomrefshow.dita ? src/tools/rtoolsijcomrefdescribe.dita I do have one question, though. Why are some doc files named with "descriptive names" and some doc files named with "numeric names"? For example, in this change, we have: ? src/tools/rtoolsijcomrefshow.dita ? src/tools/rtoolsijcomrefdescribe.dita M src/tools/rtoolsijcomref17529.dita M src/tools/derbytools.ditamap M src/tools/rtoolsijcomref39198.dita I assume this is just a side issue with my lack of understanding of the DITA process. Aside from understanding this trivial detail, everything else looks great to me.
        Hide
        Andrew McIntyre added a comment -

        Attaching zip file with the new pages for describe and show.

        Show
        Andrew McIntyre added a comment - Attaching zip file with the new pages for describe and show.
        Hide
        Andrew McIntyre added a comment -

        I hadn't realized Kristian had offered to produce a patch for this, since when I checked earlier today noone was assigned to the issue. So earlier today I started to put together a patch for this issue based on David's HTML files. I cleaned up what I had done so that it builds properly and am attaching the patch here in the hopes of preventing duplication of effort in documenting this.

        I expanded and reorganized what David had suggested, but I'm not sure that this is really ready to be committed. I put all of the syntax for SHOW into a single page, with examples for each choice in the next part of the SHOW grammar. This would seem to be slightly at odds with the way DITA organizes examples, which would have one <example> block with all of the examples for the <reference> block for SHOW.

        So, I'd really appreciate it if someone could help review and/or cleanup this patch and make it ready for commit. I'm always happy to hear suggestions as to where to go from here.

        Show
        Andrew McIntyre added a comment - I hadn't realized Kristian had offered to produce a patch for this, since when I checked earlier today noone was assigned to the issue. So earlier today I started to put together a patch for this issue based on David's HTML files. I cleaned up what I had done so that it builds properly and am attaching the patch here in the hopes of preventing duplication of effort in documenting this. I expanded and reorganized what David had suggested, but I'm not sure that this is really ready to be committed. I put all of the syntax for SHOW into a single page, with examples for each choice in the next part of the SHOW grammar. This would seem to be slightly at odds with the way DITA organizes examples, which would have one <example> block with all of the examples for the <reference> block for SHOW. So, I'd really appreciate it if someone could help review and/or cleanup this patch and make it ready for commit. I'm always happy to hear suggestions as to where to go from here.
        Hide
        Rick Hillegas added a comment -

        Bumping the urgency since the feature has gone in.

        Show
        Rick Hillegas added a comment - Bumping the urgency since the feature has gone in.
        Hide
        Kristian Waagan added a comment -

        Hi David,

        I have had a look at this, and can attach a preliminary DITA patch tomorrow. Not sure my approach is totally in line with the Tools manual, so I need some feedback on it.
        I'm clearing the patch available flag, and also assigning myself to the issue.

        If someone wants to add to the content after the first patch is submitted, feel free to assign yourself to the issue and bring it forward.

        Show
        Kristian Waagan added a comment - Hi David, I have had a look at this, and can attach a preliminary DITA patch tomorrow. Not sure my approach is totally in line with the Tools manual, so I need some feedback on it. I'm clearing the patch available flag, and also assigning myself to the issue. If someone wants to add to the content after the first patch is submitted, feel free to assign yourself to the issue and bring it forward.
        Hide
        David Van Couvering added a comment -

        I've attached the documentation, but it doesn't appear to be getting converted into DITA. Is anyone going to take this?

        Show
        David Van Couvering added a comment - I've attached the documentation, but it doesn't appear to be getting converted into DITA. Is anyone going to take this?
        Hide
        David Van Couvering added a comment -

        Not really a "patch", since it needs to be converted to DITA, but you get the idea...

        Show
        David Van Couvering added a comment - Not really a "patch", since it needs to be converted to DITA, but you get the idea...
        Hide
        David Van Couvering added a comment -

        Attached HTML files for each of the SHOW commands (which all appear to be new - at least, they're not documented) and the DESCRIBE command.

        I used StarOffice to create these, sorry if this generated a lot of cruft, but trying to do it in raw HTML was too painful.

        Show
        David Van Couvering added a comment - Attached HTML files for each of the SHOW commands (which all appear to be new - at least, they're not documented) and the DESCRIBE command. I used StarOffice to create these, sorry if this generated a lot of cruft, but trying to do it in raw HTML was too painful.
        Hide
        Andrew McIntyre added a comment -

        The online help in ij gives a description of the commands that are available. I think a brief description along with some simple examples is all that is necessary. If you don't have time to put together a DITA XML file for it, a simple HTML file can be easily DITAfied.

        For whoever takes on the DITA impl, the new describe page should be subtopics of tools/rtoolsijcomref25570.html, and the show connections page tools/rtoolsijcomref17529.html should be made generic to the show command and updated to include the new information for show tables, etc.

        Show
        Andrew McIntyre added a comment - The online help in ij gives a description of the commands that are available. I think a brief description along with some simple examples is all that is necessary. If you don't have time to put together a DITA XML file for it, a simple HTML file can be easily DITAfied. For whoever takes on the DITA impl, the new describe page should be subtopics of tools/rtoolsijcomref25570.html, and the show connections page tools/rtoolsijcomref17529.html should be made generic to the show command and updated to include the new information for show tables, etc.
        Hide
        David Van Couvering added a comment -

        This is great functionality to have and it would be really good to have this available in 10.2. It would be a shame if it were not "officially" available because of lack of documentation. Is Havard around to write the documentation? Otherwise, although I know very little about these features, I may jump in and do it.

        Show
        David Van Couvering added a comment - This is great functionality to have and it would be really good to have this available in 10.2. It would be a shame if it were not "officially" available because of lack of documentation. Is Havard around to write the documentation? Otherwise, although I know very little about these features, I may jump in and do it.

          People

          • Assignee:
            Andrew McIntyre
            Reporter:
            David Van Couvering
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development