db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (DERBY-5154) Tables in documentation should not have empty cells
Date Tue, 29 Mar 2011 16:42:05 GMT

     [ https://issues.apache.org/jira/browse/DERBY-5154?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Kim Haase updated DERBY-5154:
-----------------------------

    Attachment: DERBY-5154.zip
                DERBY-5154.stat
                DERBY-5154.diff

Attaching DERBY-5154.diff, DERBY-5154.stat, and DERBY-5154.zip, with changes as follows. (Turned
out every manual needed some sort of fix.)


Admin Guide:

cadminappsclient.dita: Accessing the Network Server by using the network client driver
Two tables needed fixing. Also made fonts consistent among tables.


Developer's Guide:

cdevdvlp40724.dita: The database directory
No empty cells, but table looked funny in frames version (left column text was centered and
bold). Result of specifying rowheader="firstcol" attribute for table. Got rid of that and
made some other formatting fixes.

cdevspecialtfgetxxx.dita: Preferred <i>getXXX()</i> methods for functions
No empty cells, but table looked funny in frames version (left column text was centered and
bold). Result of specifying rowheader="firstcol" attribute for table. Also removed some unusual
font settings and resized columns.

rdevconcepts2462.dita: Lock compatibility
Table had empty top left cell (matrix); also made cell contents more meaningful.

rdevcsecure190.dita: Read-only and full access permissions
Contained X's. Also corrected syntax error and resized columns.


Getting Started:

rgsdocs10012.dita: SQL syntax
No empty cells, but table looks funny in frames version (left column text is centered and
bold). Result of specifying rowheader="firstcol" attribute for table.


Reference Manual:

rrefsqlj33923.dita: Aggregates (set functions)
Table redone as 2-column table

rrefsqljargmatching.dita: Argument matching
"None" seemed appropriate to replace the dashes.

Filled in content for empty cells, made other corrections as needed.
rrefsistabs28114.dita: SYSALIASES system table
rrefsistabs26665.dita: SYSCHECKS system table
rrefsistabssyscolperms.dita: SYSCOLPERMS system table
rrefsistabs22441.dita: SYSCOLUMNS system table
rrefsistabs39391.dita: SYSCONGLOMERATES system table
rrefsistabs23241.dita: SYSCONSTRAINTS system table
rrefsistabs12813.dita: SYSDEPENDS system table
rrefsistabs40972.dita: SYSFILES system table
rrefsistabssysperms.dita: SYSPERMS system table
rrefsistabssyssequences.dita: SYSSEQUENCES system table
The second and third rows were out of order.
rrefsistabs33768.dita: SYSSTATEMENTS system table
rrefsistabslilanguageitemsysstatistics.dita: SYSSTATISTICS system table
Needed to fix map file: SYSSTATISTICS and SYSSTATEMENTS misalphabetized
rrefsistabssystableperms.dita: SYSTABLEPERMS system table
rrefsistabs24269.dita: SYSTABLES system table (line break in column name)
rrefsistabs79888.dita: SYSTRIGGERS system table
rrefsistabs24045.dita: SYSVIEWS system table
rrefsysxplain_statements.dita: SYSXPLAIN_STATEMENTS system table
rrefsysxplain_statement_timings.dita: SYSXPLAIN_STATEMENT_TIMINGS system table
rrefsysxplain_resultsets.dita: SYSXPLAIN_RESULTSETS system table
rrefsysxplain_resultset_timings.dita: SYSXPLAIN_RESULTSET_TIMINGS system table
rrefsysxplain_scan_props.dita: SYSXPLAIN_SCAN_PROPS system table
rrefsysxplain_sort_props.dita: SYSXPLAIN_SORT_PROPS system table

rrefjavsqlprst.dita: Prepared statements and streaming columns -- redid table

crefproper22250.dita: Derby properties -- redid table, also redid list to avoid footnote.

For derby.authentication.builtin.algorithm -- property page has usual Dynamic text, not what
is specified in pages for footnoted properties. Did not use special text. Is that okay?

crefproper22250 issues not resolved here (yet, anyway):
derby.storage.tempDirectory -- table entry says Dynamic, but property page (rrefproper34037.dita)
says Static -- which is correct?
Noticed that for properties listed as "S,D" the language is not always consistent. Seven are
like rrefproper13766.dita (derby.authentication.provider), but three are like rrefpropersqlauth.dita
(derby.database.sqlAuthorization). Probably all should be like derby.authentication.provider?

crefproper22250 issues fixed:
rrefproper27529.dita: derby.storage.initialPages
Property page didn't have a "Dynamic or static" section; added one, with usual language for
pages where scope is system-wide, though this has Conglomerate scope; is that appropriate?
rrefproper81359.dita: derby.storage.pageCacheSize:
Made language consistent with others where scope is system-wide

Two I'm not fixing:

rrefsqlj33562.dita: CAST function
rrefsqlj58560.dita: Data type assignments and comparison, sorting, and ordering (two tables)
I am afraid the vertical column heads are not accessible. I don't think we can change the
table, though. It's too big and there's no room.


Tools Guide:

rtoolsdrvrnmeurl.dita: The ij Driver name and connection URL
Also made some consistency/typo fixes

ttoolsimporting.dita: Importing data using the built-in procedures
ttoolsexporting.dita: Exporting data using the built-in procedures
Put appropriate line breaks in table codeblocks, made both tables simpletables so they look
the same (one was a choicetable before).


Tuning Guide:

ctuntransform36368.dita: Flattening a subquery into a normal join
Had a couple of one-column tables for layout, which didn't look very good anyway. Redone as
codeblocks, not tables.


> Tables in documentation should not have empty cells
> ---------------------------------------------------
>
>                 Key: DERBY-5154
>                 URL: https://issues.apache.org/jira/browse/DERBY-5154
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.7.1.1
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-5154.diff, DERBY-5154.stat, DERBY-5154.zip, systemtables.txt
>
>
> Screen readers have trouble reading tables with empty cells. These tables need to be
modified to include meaningful content.
> The Reference Manual has the most such tables, mostly in the system tables topics. All
manuals except Getting Started have at least one.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message