diff options
| author | Shaun McCance <shaunm@redhat.com> | 2020-10-17 10:46:42 -0400 |
|---|---|---|
| committer | Shaun McCance <shaunm@redhat.com> | 2020-10-17 10:46:42 -0400 |
| commit | 374131580894551b2f695a1f694924327295d27b (patch) | |
| tree | 43a1d7c9a024aaf6f06a65a9ce804219938c4b65 /xslt | |
| parent | c31954f842688bba4bc13932cd31e33c759e342e (diff) | |
| download | yelp-xsl-374131580894551b2f695a1f694924327295d27b.tar.gz | |
Adding a README for the CSS text templates
Diffstat (limited to 'xslt')
| -rw-r--r-- | xslt/common/css/README | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/xslt/common/css/README b/xslt/common/css/README new file mode 100644 index 00000000..e79f97b3 --- /dev/null +++ b/xslt/common/css/README @@ -0,0 +1,21 @@ +These are the CSS text template files used by these XSLT stylesheets. +They are maintained in separate files to make it easier to work on them. +You can call variables or XPath expression with double curly braces {{$like_this}}. +Variables are defined in the XSLT files. + +Because of limitations in XSLT, these files do have to be well-formed XML, +even though we only ever use the text value. +That means they have to be wrapped in an XML element, +and any < and & characters have to be escaped as < and &, respectively. + +Here's what each file is: + +* core.css.tmpl - The core CSS for general page layout +* elements.css.tmpl - CSS for element styles common to multiple formats +* syntax.css.tmpl - CSS for syntax highlighting, using highlight.js +* mallard.css.tmpl - CSS for element styles specific to Mallard +* docbook.css.tmpl - CSS for element styles specific to DocBook + +The easiest way to test your changes to these files is with the lipsum test document, +found under test/lipsum from the root of this repository. +That directory has a README that explains how to use it to test changes. |