db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2001) Add DITA templates for the 3 topic types into the trunk
Date Wed, 08 Nov 2006 17:50:52 GMT
    [ http://issues.apache.org/jira/browse/DERBY-2001?page=comments#action_12448210 ] 
            
Kim Haase commented on DERBY-2001:
----------------------------------

These are great, Laura. Just a few comments. 

Concept template: Great -- only a couple of spelling items.

TOPIC TITLE: Spelling is "gerund"

NOTES: Spelling is "label"


Reference template: Also fine -- formatting nits only.

REFSYN: Missing word? "that syntax or signature content" should be "that contains syntax or
signature content"?

PARAGRAPHS: need a linebreak before this comment, and again before <p>. Also, is there
a reason for the xref tag (with no space after the period)? Its presence is a  bit confusing.

TABLE: need a linebreak before this comment, and again before <table>

NOTES: need a linebreak before this comment, and again before <note>


Task template: Also nearly perfect. Are there some stray spaces at the top of the file?

TOPIC TITLE: I think there is a stray sentence that should be cut? "The title for short description
is the first paragraph in the topic and can be used as an abstract." Unless some other text
was intended.


> Add DITA templates for the 3 topic types into the trunk
> -------------------------------------------------------
>
>                 Key: DERBY-2001
>                 URL: http://issues.apache.org/jira/browse/DERBY-2001
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.2.1.6
>            Reporter: Laura Stewart
>         Assigned To: Laura Stewart
>             Fix For: 10.2.1.8
>
>         Attachments: concept_template.dita, concept_template.dita, derby2001_1.diff,
derby2001_1.stat, derby2001_2.diff, derby2001_2.stat, reference_template.dita, reference_template.dita,
task_template.dita, task_template.dita
>
>
> Create templates for each of the DITA topic types - concept, reference, task
> Add these templates to the Derby trunk so that anyone can use them.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message