You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Kim Haase (JIRA)" <ji...@apache.org> on 2010/10/11 16:09:33 UTC

[jira] Created: (DERBY-4840) Reference topic example elements lack titles

Reference topic example elements lack titles
--------------------------------------------

                 Key: DERBY-4840
                 URL: https://issues.apache.org/jira/browse/DERBY-4840
             Project: Derby
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 10.6.1.0
            Reporter: Kim Haase
            Priority: Minor


Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.) 

These <example> elements need to have <title> elements that say either "Example" or "Examples". 


-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-4840) Reference topic example elements lack titles

Posted by "Dag H. Wanvik (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12925661#action_12925661 ] 

Dag H. Wanvik commented on DERBY-4840:
--------------------------------------

Thanks for fixing this, Kim! I looked at some samples and they were fine. +1

> Reference topic example elements lack titles
> --------------------------------------------
>
>                 Key: DERBY-4840
>                 URL: https://issues.apache.org/jira/browse/DERBY-4840
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.6.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-4840-adminguide.diff, DERBY-4840-adminguide.zip, DERBY-4840-ref-1.zip, DERBY-4840-ref-2.zip, DERBY-4840-ref.diff, DERBY-4840-tools.diff, DERBY-4840-tools.zip, DERBY-4840.stat
>
>
> Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.) 
> These <example> elements need to have <title> elements that say either "Example" or "Examples". 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Closed: (DERBY-4840) Reference topic example elements lack titles

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase closed DERBY-4840.
----------------------------


Closing, since fixes have appeared in Latest Alpha Manuals.

> Reference topic example elements lack titles
> --------------------------------------------
>
>                 Key: DERBY-4840
>                 URL: https://issues.apache.org/jira/browse/DERBY-4840
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.6.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>             Fix For: 10.7.1.0
>
>         Attachments: DERBY-4840-adminguide.diff, DERBY-4840-adminguide.zip, DERBY-4840-ref-1.zip, DERBY-4840-ref-2.zip, DERBY-4840-ref.diff, DERBY-4840-tools.diff, DERBY-4840-tools.zip, DERBY-4840.stat
>
>
> Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.) 
> These <example> elements need to have <title> elements that say either "Example" or "Examples". 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-4840) Reference topic example elements lack titles

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-4840:
-----------------------------

    Attachment: DERBY-4840-ref-2.zip
                DERBY-4840-ref-1.zip

Attaching DERBY-4840-ref-1.zip and DERBY-4840-ref-2.zip, containing the HTML files for the Ref Manual changes.

Since these are formatting changes only, I am not asking anyone to review them unless you really want to (it would be very tedious). I will commit the patches in a couple days unless I hear otherwise.

> Reference topic example elements lack titles
> --------------------------------------------
>
>                 Key: DERBY-4840
>                 URL: https://issues.apache.org/jira/browse/DERBY-4840
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.6.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-4840-adminguide.diff, DERBY-4840-adminguide.zip, DERBY-4840-ref-1.zip, DERBY-4840-ref-2.zip, DERBY-4840-ref.diff, DERBY-4840-tools.diff, DERBY-4840-tools.zip, DERBY-4840.stat
>
>
> Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.) 
> These <example> elements need to have <title> elements that say either "Example" or "Examples". 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-4840) Reference topic example elements lack titles

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-4840:
-----------------------------

    Issue & fix info: [Newcomer, Patch Available]  (was: [Newcomer])

> Reference topic example elements lack titles
> --------------------------------------------
>
>                 Key: DERBY-4840
>                 URL: https://issues.apache.org/jira/browse/DERBY-4840
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.6.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-4840-adminguide.diff, DERBY-4840-adminguide.zip, DERBY-4840-ref-1.zip, DERBY-4840-ref-2.zip, DERBY-4840-ref.diff, DERBY-4840-tools.diff, DERBY-4840-tools.zip, DERBY-4840.stat
>
>
> Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.) 
> These <example> elements need to have <title> elements that say either "Example" or "Examples". 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-4840) Reference topic example elements lack titles

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-4840:
-----------------------------

    Attachment: DERBY-4840-tools.diff
                DERBY-4840-adminguide.diff
                DERBY-4840-ref.diff

Attaching proposed patches for this issue: changes to 74 topics in the Reference Manual, 4 in the Admin Guide, and 2 in the Tools Guide.

Added an "Example" or "Examples" title in example elements that needed one -- that is, where the example was a separate section and was not part of conceptual material. Also made some formatting fixes related to example elements where needed. 

Stat and zip files to come.


> Reference topic example elements lack titles
> --------------------------------------------
>
>                 Key: DERBY-4840
>                 URL: https://issues.apache.org/jira/browse/DERBY-4840
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.6.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-4840-adminguide.diff, DERBY-4840-ref.diff, DERBY-4840-tools.diff
>
>
> Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.) 
> These <example> elements need to have <title> elements that say either "Example" or "Examples". 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Resolved: (DERBY-4840) Reference topic example elements lack titles

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase resolved DERBY-4840.
------------------------------

          Resolution: Fixed
       Fix Version/s: 10.7.1.0
    Issue & fix info:   (was: [Patch Available, Newcomer])

Committed patches DERBY-4840-adminguide.diff, DERBY-4840-tools.diff, and DERBY-4840-ref.diff to documentation trunk at revision 1028853.

> Reference topic example elements lack titles
> --------------------------------------------
>
>                 Key: DERBY-4840
>                 URL: https://issues.apache.org/jira/browse/DERBY-4840
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.6.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>             Fix For: 10.7.1.0
>
>         Attachments: DERBY-4840-adminguide.diff, DERBY-4840-adminguide.zip, DERBY-4840-ref-1.zip, DERBY-4840-ref-2.zip, DERBY-4840-ref.diff, DERBY-4840-tools.diff, DERBY-4840-tools.zip, DERBY-4840.stat
>
>
> Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.) 
> These <example> elements need to have <title> elements that say either "Example" or "Examples". 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Assigned: (DERBY-4840) Reference topic example elements lack titles

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase reassigned DERBY-4840:
--------------------------------

    Assignee: Kim Haase

> Reference topic example elements lack titles
> --------------------------------------------
>
>                 Key: DERBY-4840
>                 URL: https://issues.apache.org/jira/browse/DERBY-4840
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.6.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>
> Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.) 
> These <example> elements need to have <title> elements that say either "Example" or "Examples". 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-4840) Reference topic example elements lack titles

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-4840?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-4840:
-----------------------------

    Attachment: DERBY-4840-tools.zip
                DERBY-4840-adminguide.zip
                DERBY-4840.stat

Attaching DERBY-4840.stat (list of modified files), along with DERBY-4840-adminguide.zip and DERBY-4840-tools.zip, containing the HTML files for the Admin and Tools Guide changes.

Ref Manual zips to come.

> Reference topic example elements lack titles
> --------------------------------------------
>
>                 Key: DERBY-4840
>                 URL: https://issues.apache.org/jira/browse/DERBY-4840
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.6.1.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-4840-adminguide.diff, DERBY-4840-adminguide.zip, DERBY-4840-ref.diff, DERBY-4840-tools.diff, DERBY-4840-tools.zip, DERBY-4840.stat
>
>
> Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.) 
> These <example> elements need to have <title> elements that say either "Example" or "Examples". 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.