summaryrefslogtreecommitdiffstats
path: root/README
blob: a9703673e72784afe9fca2d2585dc7c9d7ac5d14 (plain)
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
This repository contains the source files for the Docs Project, part
of the Fedora Project. Except for the Installation Guide and guides
on how to participate such as the Developer's Guide, all docs must be
tutorials written in DocBook XML article format using the template in
the example-tutorial directory. Each tutorial *must* be in its own
directory. No XML files should be in the root directory.

Four modules comprise the minimal set that must be obtained to view
or edit any document:

	bin/

		Client-side scripts and tools.

	common/
		
		DocBook XML files shared by multiple guides.

	css/

		Cascading Style Sheets (CSS) that control the "look
		and feel" used to render documents in HTML format.

		NOTE: These may not be the same stylesheets used for
		final production rendering.  Just use them as a guide
		to ensure your XML is correct, but do not expect the
		finished documents to look the same.
	
	stylesheet-images/
	
		Graphics resources used to render documents in both
		PDF and HTML format.

	xsl/

		XSLT style sheets used to render the document texts,
		which are written in DocBook XML, into either HTML or
		PDF format.

Notice:

	PDF generation is currently extremely fragile and may not
	work at all.  We are investigating this.

Any Questions? 

	Email fedora-docs-list@redhat.com.
test content for *docs* check
[end of document]