Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation for customizing stylesheets fixes #403 #407

Merged

Conversation

fgerling
Copy link
Contributor

No description provided.

@fgerling fgerling self-assigned this May 11, 2017
@fgerling fgerling requested a review from tomschr May 11, 2017 13:04
Copy link
Collaborator

@tomschr tomschr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only some minor things, but overall it looks very good! Thanks! 👍

@@ -110,8 +110,8 @@
<title>Adjusting the Layout of Variable Lists</title>
<para>
By default, the DocBook stylesheets display the contents of a
<sgmltag>variablelist</sgmltag> as a table. To change this temporarily,
set the parameter <parameter>variablelist.as.table</parameter> to <literal>0</literal> by executing the following command:
<sgmltag>variabl in your DC files.elist</sgmltag> as a table. To change this temporarily,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content in sgmltag looks strange.

<important>
<para>
The reader should be aware of that he or she needs some knowledge about
XSLT (at least a little bit). Basic customizations like parameter changes
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can omit the "he or she" if you rephrase it like:

The reader should be aware of that some knowledge about XSLT is needed.

can be done by simple adding a line with:
<screen>&lt;xsl:param name="PARAMETER_NAME" select="VALUE"/></screen>
The available parameters are format dependent and are listed in the
"XSL Stylesheets Reference Documentation".
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a link to http://docbook.sourceforge.net/release/xsl/current/doc/param.html for the "XSL Stylesheet Reference Documentation".

</para>
</important>
<para>
Best practice is to store the stylesheets in a xslt directory as the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use <filename> for "xslt"

</para>
</note>
<para>
In the following we will create the directory stucture for customizations of the HTML output.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add "procedure" after "following"

@fgerling fgerling merged commit 4f94fae into develop May 12, 2017
@tomschr tomschr deleted the feature/403_Document_How_to_Use_Your_Own_Stylesheets branch May 12, 2017 11:59
fsundermeyer added a commit that referenced this pull request Jun 14, 2017
Stable release DAPS 2.4.0:

* New Features:
  - added a dependency checker for DAPS (/usr/bin/daps-check-deps)
    that makes it easy to check for missing programs/packages
  - added a "--lean" parameter to PDF generation for creating PDFs
    with a reduced file size (by reducing the quality of included
    images); useful for sharing PDFs via e-mail
  - added a srylesheet for returning all IDs from an XML file
    (daps-xslt/common/get-all-xmlids.xsl)

* Bugfixes:
  - #408: The list-file-* commands now work with ROOTIDs from all
          possible elements
  - #390: When an ID appears twice in the XML and this ID is used
          with --rootid, DAPS's error message is unhelpful
  - #365: Improved error messages on "File not found" errors
          (now tells whether the path was provided by command-line
           or config file)
  - #371: Make path to the xmlformat config file configurable
  - #372: Adjusted debian dependency list
  - #373: Check unpack-locdrop
  - #379: Output error of list-images-multisrc with
          pretty | wc option
  - #380: Proper error messages when binaries/packages are missing
  - #392: daps-xmlformat writes name of config file into output
  - SVGs were not included in ePUBs
    (https://bugzilla.suse.com/show_bug.cgi?id=1006204)
  - Setting a default value for db5_version in configure.ac
    otherwise the DB5 URN in etc/config will be set to an invalid
    value if DB5 is not installed when running make
  - fixed a few minor issues with the config file parser that was
    introduced with 2.3.0 (among them #387)
  - Increased Java stacksize for jing
  - Improved the DocBook5 -> DocBook 4 (-> NovDoc) conversion
  - compatibility: Debian's version of "which" does not support
    long parameters

* Documentation:
  - Various updates to reflect changes in the code
  - #345: added documentatioon for the xmlformat subcommand
  - #362: added documentation for the --jobs option
  - #363: added documentation about building a bigfile from
          invalid sources
  - #364: added documentation for the --norefchecks option
  - #403: improved documentation about stylesheet customizing
          (also see #407)
  - #404: clarify doc about listing unused images
  - completely revised the doc (spelling, language and grammar)
  - doc is not yet 100% on par with the code, but we are getting
    closer

* Compatibility:
  - successfully tested DAPS on Linux Mint 18.1
fsundermeyer added a commit that referenced this pull request Jun 14, 2017
Stable release DAPS 2.4.0:

* New Features:
  - added a dependency checker for DAPS (/usr/bin/daps-check-deps)
    that makes it easy to check for missing programs/packages
  - added a "--lean" parameter to PDF generation for creating PDFs
    with a reduced file size (by reducing the quality of included
    images); useful for sharing PDFs via e-mail
  - added a srylesheet for returning all IDs from an XML file
    (daps-xslt/common/get-all-xmlids.xsl)

* Bugfixes:
  - #408: The list-file-* commands now work with ROOTIDs from all
          possible elements
  - #390: When an ID appears twice in the XML and this ID is used
          with --rootid, DAPS's error message is unhelpful
  - #365: Improved error messages on "File not found" errors
          (now tells whether the path was provided by command-line
           or config file)
  - #371: Make path to the xmlformat config file configurable
  - #372: Adjusted debian dependency list
  - #373: Check unpack-locdrop
  - #379: Output error of list-images-multisrc with
          pretty | wc option
  - #380: Proper error messages when binaries/packages are missing
  - #392: daps-xmlformat writes name of config file into output
  - SVGs were not included in ePUBs
    (https://bugzilla.suse.com/show_bug.cgi?id=1006204)
  - Setting a default value for db5_version in configure.ac
    otherwise the DB5 URN in etc/config will be set to an invalid
    value if DB5 is not installed when running make
  - fixed a few minor issues with the config file parser that was
    introduced with 2.3.0 (among them #387)
  - Increased Java stacksize for jing
  - Improved the DocBook5 -> DocBook 4 (-> NovDoc) conversion
  - compatibility: Debian's version of "which" does not support
    long parameters

* Documentation:
  - Various updates to reflect changes in the code
  - #345: added documentatioon for the xmlformat subcommand
  - #362: added documentation for the --jobs option
  - #363: added documentation about building a bigfile from
          invalid sources
  - #364: added documentation for the --norefchecks option
  - #403: improved documentation about stylesheet customizing
          (also see #407)
  - #404: clarify doc about listing unused images
  - completely revised the doc (spelling, language and grammar)
  - doc is not yet 100% on par with the code, but we are getting
    closer

* Compatibility:
  - successfully tested DAPS on Linux Mint 18.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants