[ 
https://issues.apache.org/jira/browse/DERBY-6895?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15355219#comment-15355219
 ] 

Bryan Pendleton commented on DERBY-6895:
----------------------------------------

Hi Danoja, 

The HTML looks very good. The text in the example got a little garbled during 
editing, I think? Also, it would be nice if the example also showed a few lines 
from the start of an example CSV file, showing a sample header line in the CSV 
data, to get across the point of skipping header lines.

Regarding the overall documentation process for Derby: it is described here: 
http://db.apache.org/derby/manuals/dita.html

We don't directly edit html pages; rather, we write in a markup language called 
DITA, which sort of looks like HTML but has some different tags that are useful 
for writing complex documentation.

The DITA source code is then processed by some special documentation tools that 
can produce output in a variety of documentation formats, including html.

It's typically pretty easy to take an HTML source page like the one you wrote, 
and re-format it into the DITA source. If you look at the DITA source for the 
manual page for SYSCS_IMPORT_TABLE, you will probably see what I mean.

And we also have to update the "parent topic", to have a reference to our new 
page.

If you have a chance, perhaps you could look through the 
http://db.apache.org/derby/manuals/dita.html information and see if it makes 
sense?


> Add documentation for new SYSCS_IMPORT_TABLE_BULK, SYSCS_IMPORT_DATA_BULK 
> procedures
> ------------------------------------------------------------------------------------
>
>                 Key: DERBY-6895
>                 URL: https://issues.apache.org/jira/browse/DERBY-6895
>             Project: Derby
>          Issue Type: Sub-task
>          Components: SQL
>            Reporter: Bryan Pendleton
>            Assignee: Danoja Dias
>            Priority: Minor
>         Attachments: rrefimporttableprocwithheaderlines.html
>
>
> The new system procedures proposed to be added by DERBY-4555
> need to be documented.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to