db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jean T. Anderson (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-382) Doc Review (CLOSED TO FURTHER COMMENTS): Derby Reference Manual
Date Thu, 30 Jun 2005 17:24:58 GMT
    [ http://issues.apache.org/jira/browse/DERBY-382?page=comments#action_12314790 ] 

Jean T. Anderson commented on DERBY-382:
----------------------------------------

I forgot to add this comment earlier, discussed with Jeff and he agreed I should go ahead
and post now because it cites a general confusion of nesting of terms within the html files
view of the docs.

CREATE PROCEDURE
http://incubator.apache.org/derby/docs/ref/rrefcreateprocedurestatement.html

The online "HTML files" format for reading the book doesn't expand the sections for procedure-Name,
ProcedureParameter, and ProcedureElement within the same page, like the PDF book does. So
these references are not defined and are confusing.

If there's a way to expand those subsections in the main page, that would be nice.

If that isn't possible, perhaps at least move the Example from the ProcedureElement link up
to this top level, so it's consistent with other CREATE commands, such as CREATE SYNONYM and
CREATE TABLE.


> Doc Review (CLOSED TO FURTHER COMMENTS): Derby Reference Manual
> ---------------------------------------------------------------
>
>          Key: DERBY-382
>          URL: http://issues.apache.org/jira/browse/DERBY-382
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>  Environment: all
>     Reporter: Jeff Levitt
>     Priority: Minor
>      Fix For: 10.1.1.0

>
> This issue tracks comments for the Derby Reference Manual. The deadline for posting comments
was Tuesday, June 28, noon Pacific time.
> PLEASE DO NOT POST ADDITIONAL COMMENTS TO THIS JIRA ISSUE.  If you have additional comments,
please open a JIRA issue for a fixin in a future release, as there is not enough time to incorporate
additional comments.
> Some guidelines to follow when posting comments to this issue are:
> - Try to make clear and concise comments about what you want changed whenever possible.
 Provide concrete comments that say "Please change <original> to <modified>" instead
of generic comments like "This section needs to be rewritten."
> - If you're reviewing the HTML Files copy, include the URL for the page in the review
comment. Obtain the URL like this:
>     * highlight the topic in the left frame
>     * right click
>     * choose "Properties"
>     * copy and paste the address in the pop up box.
> - If you're reviewing the PDF copy, in the review comment:
>     * Include the page number for the PDF, and indicate whether the number is the PDF
sheet number or the printed page number.
>     * Include the title of the section that the problem occurs in. If it's in a subsection,
try to include the hierarchy of titles.
> - Please don't review the HTML Book copy -- it'll be time consuming to match up that
copy with the underlying DITA source.

-- 
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