[
https://issues.apache.org/jira/browse/DERBY-5184?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Kim Haase updated DERBY-5184:
-----------------------------
Attachment: DERBY-5184-ref.zip
DERBY-5184-ref.stat
DERBY-5184-ref.diff
Attaching DERBY-5184-ref.diff, DERBY-5184-ref.stat, and DERBY-5184-ref.zip,
with changes to the following 55 Reference Manual topics. The previous version
had 139 formal tables, including 30 without titles. Topics are listed in the
order in which they appear in the manual.
rrefsqlj37836.dita generated-column-spec (1 formal)
rrefsqlj19433.dita SQL expressions (4 formal)
rrefsqlj23075.dita Boolean expressions (1 formal, introduced by xref)
rrefsqlj33923.dita Aggregates (set functions) (1 formal, introduced by xref)
rrefsqlj33562.dita CAST function (1 formal, properly introduced) (try
valign="bottom")
rrefsyscsdiagtables.dita SYSCS_DIAG diagnostic tables and functions (2 formal;
1 properly introduced, 1 with no title)
Oh no! one more table with empty cells that I missed! It's just like the system
tables and XPLAIN tables so I put the same values in (19 for BIGINT, 10 for
INTEGER). I deduced that SMALLINT is 5. Is that right?
rrefsqlj27767.dita Numeric type promotion in expressions (1 formal, introduced
by xref)
rrefsqlj58560.dita Data type assignments and comparison, sorting, and ordering
(2 formal, with <desc> elements)
rrefsqljargmatching.dita Argument matching (1 formal, properly introduced)
rrefsql9241891.dita Derby support for SQL-92 features (26 formal, 1 properly
introduced) (Intro should apply to all, and no sections should be used (so that
they will be numbered consecutively in the frames version)
rrefsistabs28114.dita SYSALIASES system table (all formal but with no title)
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
rrefsistabs13420.dita SYSFOREIGNKEYS system table
rrefsistabs33921.dita SYSKEYS system table
rrefsistabssysperms.dita SYSPERMS system table
rrefsistabssysroles.dita SYSROLES system table
rrefsistabssysroutineperms.dita SYSROUTINEPERMS system table
rrefsistabs12085.dita SYSSCHEMAS system table
rrefsistabssyssequences.dita SYSSEQUENCES system table
rrefsistabs33768.dita SYSSTATEMENTS system table
rrefsistabslilanguageitemsysstatistics.dita SYSSTATISTICS system table
rrefsistabssystableperms.dita SYSTABLEPERMS system table
rrefsistabs24269.dita SYSTABLES system table
rrefsistabs79888.dita SYSTRIGGERS system table
rrefsistabs24045.dita SYSVIEWS system table
rrefsysxplain_statements.dita SYSXPLAIN_STATEMENTS system table
Each topic: changed "see the RUNTIMESTATISTICS section in the
<ph conref="../conrefs.dita#pub/citref"></ph> for more information on how to
configure this" to "See "Working with RunTimeStatistics" in the
<ph conref="../conrefs.dita#pub/cittuning"></ph> for information on how to
configure this". There is no RUNTIMESTATISTICS section in the Reference Manual,
only two different sections on SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS and
SYSCS_UTIL.SYSCS_SET_RUNTIMESTATISTICS that don't say anything about
configuring XPLAIN. All of that is in the tuning guide.
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
rrefexcept71493.dita SQL error messages and exceptions (52 formal) (generated,
can't touch, and no need)
rrefjdbc27734.dita java.sql.Connection interface (1 formal)
rrefjdbc40794.dita java.sql.Statement interface (1 formal)
rrefjdbc75719.dita CallableStatements and INOUT Parameters (1 formal)
Please check updated version.
rrefjavsqlprst.dita Prepared statements and streaming columns (1 formal,
properly introduced)
rrefjdbc23502.dita java.sql.ResultSet interface (1 formal)
rrefjdbc38274.dita java.sql.ResultSetMetaData interface (1 formal, but with no
title)
rrefjdbc20377.dita Mapping of java.sql.Types to SQL types (1 formal, properly
introduced)
rrefjdbc96386.dita Mapping of java.sql.Blob and java.sql.Clob interfaces (2
formal)
rrefattrib56769.dita territory=ll_CC attribute (2 formal)
rrefattribtracelevel.dita traceLevel=value attribute (1 formal, properly
introduced)
crefproper22250.dita Derby properties (1 formal, introduced by xref)
rrefsqlj75638.dita Supported territories (1 formal, but with no title)
rrefdbmlimits.dita Limitations for database manager values (1 formal, with
<desc> element)
rrefdttlimits.dita DATE, TIME, and TIMESTAMP limitations (1 formal, properly
introduced)
rrefidlengthlimits.dita Limitations on identifier length (1 formal, with <desc>
element)
rrefnumericlimits.dita Numeric limitations (1 formal)
rrefstringlimits.dita String limitations (1 formal, with <desc> element)
rreflimitsxml.dita XML limitations (1 formal)
> Tables in documentation need introductions and formatting fixes
> ---------------------------------------------------------------
>
> Key: DERBY-5184
> URL: https://issues.apache.org/jira/browse/DERBY-5184
> Project: Derby
> Issue Type: Sub-task
> Components: Documentation
> Affects Versions: 10.7.1.1
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-5184-admin.diff, DERBY-5184-admin.stat,
> DERBY-5184-admin.zip, DERBY-5184-dev.diff, DERBY-5184-dev.stat,
> DERBY-5184-dev.zip, DERBY-5184-gs.diff, DERBY-5184-gs.stat,
> DERBY-5184-gs.zip, DERBY-5184-ref.diff, DERBY-5184-ref.stat,
> DERBY-5184-ref.zip, JDBCTypePrinter.java
>
>
> Many tables in the Derby documentation appear abruptly, with conceptual prose
> followed immediately by a table (with or without a title). Here are some
> examples:
> http://db.apache.org/derby/docs/dev/devguide/devguide-single.html#tdevupgradedb
> http://db.apache.org/derby/docs/dev/adminguide/adminguide-single.html#cadminappsclient
> http://db.apache.org/derby/docs/dev/ref/ref-single.html#rrefjdbc27734
> There is no specific accessibility requirement that tables be properly
> introduced, but many companies' technical writing style guides require or
> strongly recommend it. Moreover, the WCAG guidelines have the following
> statements (http://www.w3.org/TR/WCAG10/#context-and-orientation):
> "Content developers should make content understandable and navigable. This
> includes not only making the language clear and simple, but also providing
> understandable mechanisms for navigating within and between pages. Providing
> navigation tools and orientation information in pages will maximize
> accessibility and usability. ... The theme of making content understandable
> and navigable is addressed primarily in guidelines 12 to 14."
> Therefore, in the interest of accessibility, each table should be introduced
> with some indication that a table is coming.
> Further details will be provided in comments.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
