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] Commented: (DERBY-4349) Documentation build files incorrectly specify missing stylesheet
Date Thu, 13 Aug 2009 14:38:14 GMT

    [ https://issues.apache.org/jira/browse/DERBY-4349?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12742840#action_12742840
] 

Kim Haase commented on DERBY-4349:
----------------------------------

The solution for the two stylesheet problems is to make one small change each to the build.xml
file and the docs.properties file.

Adding the following line at the end of docs.properties gets rid of the absolute path:

  args.csspath=
  
This results in the following output:

<link href="commonltr.css" type="text/css" rel="stylesheet" />

And fixing the following target in build.xml includes the stylesheet in the output directory
for each document:

  <target name="html.dita">
    <!-- build to temp directory, then move the files over to the correct -->
    <!-- directory name, prepending the Apache License as we go.          -->
    <mkdir dir="${dita.dir}/temp"/>
    <mkdir dir="${basedir}/out/${manual.name}temp"/>
    <copy todir="${basedir}/out/${manual.name}temp">
      <fileset dir="${dita.dir}/resource"
               includes="index.html"/>
      <filterchain>
        <tokenfilter>
          <replaceregex pattern="Web Sample" replace="${manual.title}"/>
        </tokenfilter>
      </filterchain>
    </copy>
    ...

Changing the includes line to the following causes the stylesheet to be copied to the temp
directory and therefore to the final output directory:

               includes="index.html,commonltr.css"/>

Including the stylesheet improves the formatting of the HTML pages: It inserts vertical spaces
above notes and the topic links at the ends of topics. It puts the terms in definition lists,
as well as the introductory words in notes ("Note" or "Important", for example) in bold. It
also reduces the size of topic heads and slightly increases the size of sub-heads.

> Documentation build files incorrectly specify missing stylesheet
> ----------------------------------------------------------------
>
>                 Key: DERBY-4349
>                 URL: https://issues.apache.org/jira/browse/DERBY-4349
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.5.2.0
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>
> A link in the metadata for generated HTML files calls for a stylesheet that is part of
the DITA toolkit. There are two problems:
> 1. The stylesheet doesn't actually appear in the output directories for the documentation,
so it is not used.
> 2. The link currently appears with the absolute pathname of the stylesheet in the temp
directory for each document. For the Latest Alpha Manuals currently, for example, it looks
like this for a page in the Getting Started guide:
> <link href="C:\nightlies\docs-trunk\out\getstarttemp\commonltr.css" type="text/css"
rel="stylesheet" />
> Specifying an absolute pathname is obviously not desirable, because the pathname reflects
where the docs were built, not where they are installed, and because the temp directory disappears
after the docs are built anyway.
> There's a simple fix for each of these problems.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message