Provide a Method to Add Resource Files (CSS, JS, Images) [sf#102]

[tomschr]

Reported by tom_schr on 2012-08-31 11:45 UTC DAPS doesn't support "resource" files. A resource file in this ticket can be of type:

• CSS files (plural!)
• JavaScript
• Images

Currently, daps allows to add only one CSS file in the DC file or as a command line option. This method is a bit too restrictive as there might be situations where it is desirable to have more CSS files. For example, you want to maintain your CSS in different files or you need to incorporate a CSS file from a remote resource.

Apart from the CSS file(s), some layout needs JavaScript or image files. As they are not referenced directly in any DocBook source, they need to be kept separately.

Please investigate, how we could add these resource files to daps.

[tomschr]

Commented by tom_schr on 2012-10-19 13:06 After discussing this topic with Frank, we came up with the following structures in our xhtml/ subdirectory:

suse
 +-- xslt
     +-- xhtml
         +-- static (was: styles)
             +-- css
             +-- js
             +-- images

What does it mean?

• DAPS looks for a "styles" subdirectory from the target format. If there is one, daps copies the content from styles into its build directory.
• The images directory obtains a special treatment. It is "merged" with the images directory of the build folder, allowing "customizations". That means, if the format-specific image folder contains a file with the same name than DocBook's images files (admonitions, callouts, etc.) it will be overwritten in the target.

Stefan, do you think this is useful?

[tomschr]

Commented by sknorr on 2012-10-19 13:35 Thanks, Tom & Frank. Sound good to me. I have two remarks:

• The "styles" folder might better be called "resources" (shorter: "res") or maybe "static."
• I think there should be two image folders. Having boilerplate images overwrite content images (or vice versa) is IMHO not so useful. The easiest way to achieve might actually be to throw content images in the same folder the HTML files are in. This might not necessarily look very clean, though.

And a final note: We should be very careful with symlinks in the resources. I think they're handled differently in Chrome/Chromium and Firefox. (Firefox seems resolve the symlink target and consequently finds resources that are referenced relatively from within the symlinked resource; Chrome doesn't seem to.)

[tomschr]

Commented by sknorr on 2012-10-19 13:43 Because my note above about symlinks probably isn't very clear, I'll try an example: Suppose we have symlinked the CSS file actual/path/style.css into the directory output/path/ where index.html expects it. Then suppose we have an image actual/path/image.png which is referenced relatively in style.css as "image.png". Firefox: notices that style.css actually comes from actual/path/ and finds image.png Chrome: thinks that style.css is located in output/path/ and won't find image.png Tom and Frank can't reproduce. Ignore this, then.

[tomschr]

Commented by tom_schr on 2012-10-19 14:41 I like the static name. :)

[tomschr]

Commented by tom_schr on 2012-10-22 06:29 Ok, basic static/ subdirectories created in suse/xslt/xhtml/ and suse/xslt_suse2/xhtml/ (see revision 2160).

[tomschr]

Commented by tom_schr on 2012-10-22 06:49 Ok, copied content in former contrib/layout/wip directory to suse/xslt_suse2/xhtml/ and created maintenance links. See revisions 2161-2163.

[tomschr]

Updated by fsundermeyer on 2012-12-06 15:06

• status: open --> closed

[tomschr]

Commented by fsundermeyer on 2012-12-06 15:06 DAPS now (SVN commit 2341 (branch) supports a static/ directory.It needs to be placed directly in the STYLEROOT (and not in the html or xhtml subdirectory) and needs to have the following structure:

/static |--css/ |--images/ |--js/ Subdirectories in css/, images/, and js/ are allowed. If /static is detected it will automatically be used and all custom css declarations (--css or HTML_CSS) will be ignored. The standard DocBook way of providing images and CSS files is still supported - it will be used when no static/ directory is found. In this case you need to provide a css file with --css or HTML_CSS (otherwise no css link will be geneated in the HML).