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 "Øystein Grøvlen (JIRA)" <de...@db.apache.org> on 2006/10/17 13:15:34 UTC
[jira] Created: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
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
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
[jira] Commented: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Øystein Grøvlen (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1968?page=comments#action_12443262 ]
Øystein Grøvlen commented on DERBY-1968:
----------------------------------------
Putting each property on a separate line seems fine to me.
For the example I suggest saying that ij on start-up connects to a database called sample using an EmbeddedDataSource and that the database is created if it does not already exist.
I also wonder if the example should end with the 'ij>' prompt like the other examples in this chapter.
> 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
[jira] Resolved: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1968?page=all ]
Andrew McIntyre resolved DERBY-1968.
------------------------------------
Fix Version/s: 10.2.1.8
10.3.0.0
Resolution: Fixed
Derby Info: (was: [Patch Available])
Committed to trunk with 465415 and 10.2 doc branch with 465416.
> 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
> Fix For: 10.2.1.8, 10.3.0.0
>
> Attachments: DERBY-1968.diff, rtoolsijproprefdatasource.html
>
>
> 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
[jira] Updated: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Kim Haase (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1968?page=all ]
Kim Haase updated DERBY-1968:
-----------------------------
Attachment: DERBY-1968.diff
rtoolsijproprefdatasource.html
Attaching patch file (DERBY-1968.diff) and HTML output showing changes. Have implemented Oystein's and Laura's suggestions, except that <b> tags in codeblocks are still needed to indicate the difference between command input and command output.
> 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
> Attachments: DERBY-1968.diff, rtoolsijproprefdatasource.html
>
>
> 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
[jira] Commented: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Øystein Grøvlen (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1968?page=comments#action_12443379 ]
Øystein Grøvlen commented on DERBY-1968:
----------------------------------------
Looks very good. I recommend that it be committed.
> 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
> Attachments: DERBY-1968.diff, rtoolsijproprefdatasource.html
>
>
> 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
[jira] Commented: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Kim Haase (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1968?page=comments#action_12443074 ]
Kim Haase commented on DERBY-1968:
----------------------------------
Yes, that works fine for the lines above -- the <varname> tags italicize the placeholders.
There's a problem in the example below, though, where we want to distinguish the user input from the system output. It turns out that our toolkit doesn't do anything with <userinput> tags (we'd like it to put the contents in bold font, I think). Should this be yet another bug?
> 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
[jira] Commented: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Øystein Grøvlen (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1968?page=comments#action_12442885 ]
Øystein Grøvlen commented on DERBY-1968:
----------------------------------------
I think it would also be good if the associated example (and other examples in this manual) included a statement of what it is trying to achieve.
> 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
> 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
[jira] Updated: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Kim Haase (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1968?page=all ]
Kim Haase updated DERBY-1968:
-----------------------------
Derby Info: [Patch Available]
> 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
> Attachments: DERBY-1968.diff, rtoolsijproprefdatasource.html
>
>
> 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
[jira] Assigned: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Kim Haase (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1968?page=all ]
Kim Haase reassigned DERBY-1968:
--------------------------------
Assignee: Kim Haase
> 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
[jira] Commented: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Laura Stewart (JIRA)" <de...@db.apache.org>.
[ http://issues.apache.org/jira/browse/DERBY-1968?page=comments#action_12443057 ]
Laura Stewart commented on DERBY-1968:
--------------------------------------
Can both the bold and italic be omitted?
I think that the example is clear without them.
If the italic is desired, then the <varname> tag should be used.
> 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
[jira] Commented: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Kim Haase (JIRA)" <de...@db.apache.org>.
[ 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
[jira] Closed: (DERBY-1968) Derby tools guide: Long line in
documentation of ij.dataSource
Posted by "Øystein Grøvlen (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-1968?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Øystein Grøvlen closed DERBY-1968.
----------------------------------
I have checked that this has been fixed in the current manual.
> Derby tools guide: Long line in documentation of ij.dataSource
> --------------------------------------------------------------
>
> Key: DERBY-1968
> URL: https://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
> Fix For: 10.2.2.0, 10.3.0.0
>
> Attachments: DERBY-1968.diff, rtoolsijproprefdatasource.html
>
>
> 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.
-
You can reply to this email to add a comment to the issue online.