Project

Profile

Help

How to connect?
Download (2.92 KB) Statistics
| Branch: | Revision:

he / src / viewer_appJS / readme.txt @ 7728ae0b

1
The viewer_appJS directory is the container for all the resource files used for rendering the Saxon documentation
2
using Saxon-JS. 
3

    
4
This directory is designed to be maintained under source-control, but also to be used as a localhost web-server
5
virtual directory to view the documentation in a browser.
6

    
7

    
8
Directories
9
-----------
10

    
11
1. doc
12
------
13
Container for all the documentation content XML files (such as about.xml), and two special reference files:
14
implement.xml - which contains implementation status notes (used in the Function Library and XSLT Element Reference);
15
and catalog.xml which is the top-level contents reference file that references all of the other XML files in the
16
directory. The catalog.xml file is used by the XSLT to update /index.html.
17

    
18
2. docimg
19
---------
20
Container for content image resources (as referenced with img tags).
21

    
22
3. dotnetdoc-xml
23
----------------
24
.NET API documentation content XML files, generated from code.
25

    
26
4. html
27
-------
28
Container for static HTML files generated by transforming files in the 'doc' directory. (Not maintained under
29
source-control.)
30

    
31
5. image
32
--------
33
Container for the images used by the viewer application - such as icon images, logos, etc.
34

    
35
6. javadoc-xml
36
--------------
37
Java API documentation content XML files, generated from code.
38

    
39
7. Saxon-JS
40
-----------
41
Contains the Saxon-JS release to be used (currently SaxonJS2.rt.js as specified in index.html).
42

    
43
8. xsl
44
------
45
Holds the source XSLT files, and the Saxon-EE generated SEF (stylesheet export file) used by Saxon-JS to render the web
46
pages dynamically. The main stylesheet is viewer_app.xsl.
47

    
48

    
49
Top-level Files
50
---------------
51

    
52
1. index.html
53
-------------
54
The entry-point for the website - this is modified by Saxon-JS using catalog.xml as the starting point.
55

    
56
2. saxon-base.css
57
-------------
58
Base CSS style sheet for the Saxonica website, imported by viewer_app.css.
59

    
60
3. viewer_app.css
61
-------------
62
Style definitions controlling both page layout and content rendering.
63

    
64
4. viewer_app.js
65
-------------
66
Contains javascript functions used by the Saxon-JS viewer_app XSLT.
67

    
68

    
69
Other Dependencies
70
------------------
71

    
72
Sibling directories of viewer_appJS directory. Containing source and stylesheets from which the documentation content is
73
generated.
74

    
75
1. src
76
------
77
Contains base source XML files for documentation content.
78

    
79
2. style
80
--------
81
Contains XSLT stylesheet files used to preprocess XML from src to generate viewer_appJS/doc files.
82

    
83
3. to-static
84
------------
85
Holds the XSLT files used to build a static version of the documentation for SEO (search engine optimization) purposes,
86
or for use in browsers with JavaScript disabled. The XSLT files here mostly correspond to those in the main
87
'xsl' directory. Note that the build for the static HTML files is now incorporated into the main Saxon (documentation)
88
ANT build files. The main stylesheet is s-viewer_app.xsl which processes the XML files in the 'doc'
89
directory, and generates the content in the 'html' directory.
(2-2/5)