Re: [jira] Commented: (DERBY-1968) Derby tools guide: Long line in documentation of ij.dataSource

2006-10-19 Thread Kim Haase
Thanks very much, Øystein.

Kim

Øystein Grøvlen (JIRA) wrote On 10/18/06 19:11,:
 [ 
 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)
 
 



[jira] Commented: (DERBY-1968) Derby tools guide: Long line in documentation of ij.dataSource

2006-10-18 Thread JIRA
[ 
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] Commented: (DERBY-1968) Derby tools guide: Long line in documentation of ij.dataSource

2006-10-18 Thread JIRA
[ 
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

2006-10-17 Thread JIRA
[ 
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] Commented: (DERBY-1968) Derby tools guide: Long line in documentation of ij.dataSource

2006-10-17 Thread Kim Haase (JIRA)
[ 
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.

codeblockbij.dataSource=idataSourcename/i/b 
bij.dataSource.databaseName=idatabasename/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] Commented: (DERBY-1968) Derby tools guide: Long line in documentation of ij.dataSource

2006-10-17 Thread Laura Stewart (JIRA)
[ 
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

2006-10-17 Thread Kim Haase (JIRA)
[ 
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