db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-1968) Derby tools guide: Long line in documentation of ij.dataSource
Date Tue, 17 Oct 2006 20:23:36 GMT
    [ http://issues.apache.org/jira/browse/DERBY-1968?page=comments#action_12443054 ] 
            
Kim Haase commented on DERBY-1968:
----------------------------------

This is in the file rtoolsijproprefdatasource.dita.

I notice that the codeblock that contains the long line looks strange. I think the text is
supposed to be on three different lines, but in the DITA source it is not.

<codeblock><b>ij.dataSource=<i>dataSourcename</i></b> <b>ij.dataSource.databaseName=<i>databasename</i></b>
<b>[ij.dataSource.createDatabase=create]</b></codeblock>

This is another case of DERBY-408, where the untagged white space in a codeblock is ignored.
However, the source at some point lost the line breaks too. I believe the output is meant
to look like this (I won't try to reproduce the italics), with the brackets indicating that
the last property is optional:

ij.dataSource=dataSourcename
ij.dataSource.databaseName=databasename
[ij.dataSource.createDatabase=create]

For an explanation of the example, would it be enough to say the following?

The following example creates a database named sample using an EmbeddedDataSource.

Or do you think more is needed? Thanks for any feedback.

> Derby tools guide: Long line in documentation of ij.dataSource
> --------------------------------------------------------------
>
>                 Key: DERBY-1968
>                 URL: http://issues.apache.org/jira/browse/DERBY-1968
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.2.1.6, 10.3.0.0
>         Environment: PDF files
>            Reporter: Øystein Grøvlen
>         Assigned To: Kim Haase
>            Priority: Trivial
>
> In the definition of ij.dataSource in the Tools Guide, a line is wider than the page.
 (Page 16 in 10.2 documentation)

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