forked from ncbi/JATSPreviewStylesheets
/
readme.txt
160 lines (132 loc) · 5.57 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
NISO Journal Article Tag Suite (JATS) version 1.0
Preview XSLT stylesheets
For documentation on these stylesheets, see:
quickstart.pdf -- "Bare bones" instructions
user-docs.pdf -- User documentation including assumptions
and limitations
technical-docs.pdf -- More technical documentation, especially
for those who wish to customize their
environment or the stylesheets
Or the same documents in HTML format.
These same documents are included with tagging according to
NISO JATS 1.0, from which the PDF and HTML was
generated:
quickstart.xml
user-docs.xml
technical-docs.xml
As such, they are suitable for testing the stylesheets.
As described in the documentation, these XSLT 1.0 transformations
will work standalone:
xslt/main/jats-html.xsl
xslt/main/jats-xslfo.xsl
To provide additional functionality, these stylesheets are also
called into pipelines, which may be invoked using stylesheets
included in the shells/saxon directory:
jats-APAcit-html.xsl
jats-APAcit-xslfo.xsl
jats-PMCcit-html.xsl
jats-PMCcit-print-fo.xsl
jats-PMCcit-web-html.xsl
jats-PMCcit-xhtml.xsl
jats-PMCcit-xslfo.xsl
jats-oasis-PMCcit-fo.xsl
As described in the documentation, these are XSLT 2.0 with Saxon
extensions, and require a recent version of the Saxon processor
to run. (Tested under Saxon 9.4.)
Or if XProc is preferred, use the XProc versions (with the same names)
given in the shells/xproc directory.
Plus, there is a CSS stylesheet to be used with HTML results of
any of these processes (including the HTML versions of the
documentation):
jats-preview.css
The file saxon-bug-readme.txt describes a bug that *may* be encountered
when using one of the stylesheets with certain versions of Saxon (or
with XProc invoking Saxon), which is most easily addressed by upgrading
the tool (to a copy distributed since the bug was reported and fixed).
The following files are included in this distribution
(as described in the documentation):
¦ jats-preview.css
¦ quickstart.html
¦ quickstart.pdf
¦ quickstart.xml
¦ readme.txt
¦ README.md
¦ saxon-bug-readme.txt
¦ technical-docs.html
¦ technical-docs.pdf
¦ technical-docs.xml
¦ userguide.html
¦ userguide.pdf
¦ userguide.xml
¦
+---shells
¦ +---saxon
¦ ¦ jats-APAcit-html.xsl
¦ ¦ jats-APAcit-xslfo.xsl
¦ ¦ jats-oasis-PMCcit-fo.xsl
¦ ¦ jats-PMCcit-html.xsl
¦ ¦ jats-PMCcit-print-fo.xsl
¦ ¦ jats-PMCcit-web-html.xsl
¦ ¦ jats-PMCcit-xhtml.xsl
¦ ¦ jats-PMCcit-xslfo.xsl
¦ ¦
¦ +---xproc
¦ jats-APAcit-html.xpl
¦ jats-APAcit-xslfo.xpl
¦ jats-oasis-PMCcit-fo.xpl
¦ jats-PMCcit-html.xpl
¦ jats-PMCcit-print-fo.xpl
¦ jats-PMCcit-web-html.xpl
¦ jats-PMCcit-xhtml.xpl
¦ jats-PMCcit-xslfo.xpl
¦
+---xslt
+---citations-prep
¦ jats-APAcit.xsl
¦ jats-PMCcit.xsl
¦
+---main
¦ jats-html.xsl
¦ jats-xslfo.xsl
¦ shell-utility.xsl
¦ xhtml-tables-fo.xsl
¦
+---oasis-tables
¦ oasis-table-html.xsl
¦ oasis-table-support.xsl
¦ oasis-table.sch
¦
+---post
¦ xhtml-ns.xsl
¦
+---prep
jats-printfilter.xsl
jats-webfilter.xsl
oasis-tables-html.xsl
----------------------------------------------------------------------------------------------------
Our policy on merging changes:
These stylesheets are provided as a point of entry for JATS users who may not have
the resources to create them from scratch. Because there are many varied
implementations of JATS, you should have no expectation that these stylesheets will
create production ready files in any arbitrary system. Instead, the stylesheets should be
customized for your particular needs.
Because we view these stylesheets as a template for a customized solution, not
the solution itself, we will accept changes that fix an actual bug, but we will
not merge in changes that we view as “customization”. For example, we will accept
changes that fix a problem which otherwise leads to failure in creating a final output
file, but we will not accept changes that focus on presentational aspects of the final
output (such as font changes, margin changes, graphics sizing, etc).
If you believe that you have a customization of the stylesheets that would benefit
other users please fork this repository and announce your fork on the JATS mailing list,
http://www.mulberrytech.com/JATS/JATS-List/.
----------------------------------------------------------------------------------------------------
This work is in the public domain and may be reproduced, published or
otherwise used without the permission of the National Library of Medicine (NLM).
We request only that the NLM is cited as the source of the work.
Although all reasonable efforts have been taken to ensure the accuracy and
reliability of the software and data, the NLM and the U.S. Government do
not and cannot warrant the performance or results that may be obtained by
using this software or data. The NLM and the U.S. Government disclaim all
warranties, express or implied, including warranties of performance,
merchantability or fitness for any particular purpose.
----------------------------------------------------------------------------------------------------