From: Robert Soulliere Date: Mon, 25 Oct 2010 19:13:02 +0000 (-0400) Subject: Add some tips and remove some revision tag references from element glossary. X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=01c1c92adb6e355c1d98e189cb5f09f14bf0bc5d;p=Evergreen-DocBook.git Add some tips and remove some revision tag references from element glossary. Revision history can be tracked by repository so revision tags may not be needed by DIG? --- diff --git a/style_guide/glossary.xml b/style_guide/glossary.xml index ccd9243..96ea591 100644 --- a/style_guide/glossary.xml +++ b/style_guide/glossary.xml @@ -517,19 +517,9 @@ date - Wrapper for date info in any context. Mandatory component of chapter - revision entries. Format is YYYY-MM-DD + Wrapper for date info in any context. Format is YYYY-MM-DD - - - authorinitials - - - An author's initials, mandatory componenet of the chapter revision element. - - simplesect diff --git a/style_guide/tips.xml b/style_guide/tips.xml index 3e2a411..cab4da6 100644 --- a/style_guide/tips.xml +++ b/style_guide/tips.xml @@ -8,16 +8,16 @@ - - Table column width + + Table column width - If column width is not specified in the XML, tables will look different depending on - the output format. In HTML the columns automatically adjust to fit contents, but in PDF - the page width is divided evenly by the number of columns. This often wastes space in - PDF tables so setting relative column widths for all tables is recommended. - In the example below, the colwidth parameter defines relative - column width. Columns 1 and 2 are of equal width, each using a quarter of the page. - Column 3 is twice the size and covers the remaining half of the page. + If column width is not specified in the XML, tables will look different depending on + the output format. In HTML the columns automatically adjust to fit contents, but in PDF + the page width is divided evenly by the number of columns. This often wastes space in + PDF tables so setting relative column widths for all tables is recommended. + In the example below, the colwidth parameter defines relative + column width. Columns 1 and 2 are of equal width, each using a quarter of the page. + Column 3 is twice the size and covers the remaining half of the page. @@ -26,16 +26,55 @@ ]]> - - For details see DocBook XSL: The - Complete Guide. - + For details see DocBook XSL: The + Complete Guide. + To avoid the following error during processing of PDF files, + +WARNING: table-layout="fixed" and column-width unspecified => falling back to proportional-column-width(1) + + it seems necessary to add decimal values in the colwidth parameter <colspec colwidth="1.0*"/ > + See http://osdir.com/ml/fop-users-xmlgraphics.apache.org/2009-04/msg00109.html + + + Using CDATA for XML Code + if you find yourself with long <programlisting> or <screen> sections that contain a lot of XML code, you can + wrap the whole thing in <![CDATA[ .... ]]> and the XML parser will skip it. For example: + + + + + + /tmp/persist.db + + +]]> + +]]> + + It's a lot easier to add the <![CDATA[ .... ]]> wrapper than change the individual occurances of < and >. + + + Semantic Oriented Markup + Adopting more semantic markup gives us the ability to have more fine-grained control over the stylesheets and resulting output. Finding semantic alternatives to the + <emphasis> tag is important for allowing more control over display of the content. + Here are some examples of existing DocBook tags which should be used in place of <emphasis>: + + <command> is used for command names + (http://www.docbook.org/tdg5/en/html/command.html) + <filename> is used for file paths and file names + (http://www.docbook.org/tdg5/en/html/filename.html) + <option> is used for command options + (http://www.docbook.org/tdg5/en/html/option.html) + <systemitem class="username"> is used for user names + (http://www.docbook.org/tdg5/en/html/systemitem.html) + - -