Contents of /manuals/trunk/tutorial/AUTHOR-INFO


This file contains information for current/prospective contributors
to the Debian Tutorial.

------------------------
IMPORTANT: Your work will be placed under the FSF documentation license
and/or the GPL, and we would like to leave open the possibility of 
assigning copyright for the work to either SPI or the FSF, excluding
the parts which are copyrighted by Larry Greenfield.

YOU SHOULD HAVE READ THE GPL AND THE FSF DOCUMENTATION LICENSE, AND
BE COMFORTABLE WITH THEM. IF YOU ARE NOT, PLEASE DO NOT CONTRIBUTE
TO THIS MANUAL.

When writing it is VERY VERY important that you not refer to any document
with unknown copyright or a copyright other than the FSF documentation
license. Please do not copy even a single sentence verbatim from other 
sources. Plagiarism will get us sued and ruin the possibility 
of publishing this document. Note that trivial rewordings are not good
enough; you need to *rewrite* everything - new analogies, new structure,
new order of presentation, new content.

Thanks, and apologies that that is necessary. On to the interesting
stuff - please read this whole file.

------------------------

The files in this directory are meant to be updated by everyone. Feel
free to add your own notes to the notes files, and of course you'll
want to change the Tutorial source file.

Notes on the source file:

I'm using --- for dash, on the principle that it can be
search-and-replaced later if it's the wrong thing.

Put a FIXME when something's wrong, and we can grep for these
prior to public releases.

The chapter/section id's are hierarchical, to create "namespaces".

Emacs PSGML mode will screw up the <example></example> indentation. 
These have to stay left-justified. So you can't indent the whole
document at once, you have to dodge the <example> parts. Fill will
also screw up the <example> sections, obviously.

"Configuration" chapters (mostly toward the end) have low priority,
these are supposed to be in the Installation Manual.

If in doubt, explain it. We're not paying for paper so be thorough. :)

If you're working on a chapter or section feel free to change around,
remove, add headings.

The use of <tt> vs. <prgn> is a little inconsistent. Probably ought to
be fixed. 

<em> can be used to mark the first occurence of an important concept, 
e.g. "this part of the system is called the <em>kernel</em>"

Note the '<enumlist> <item> <p> <tt>command </tt> <p> explanation'
format for tutorials. This is vastly inferior to DocBook. For now 
we'll have to suck it up and deal.

If you make changes, please add to the ChangeLog. Emacs has a
ChangeLog mode that's nice. Otherwise copy the format of previous
entries.

You should read the section on keys and try to use the notation
described there. It's the same as the Emacs manual's notation.


1
2	This file contains information for current/prospective contributors
3	to the Debian Tutorial.
4
5	------------------------
6	IMPORTANT: Your work will be placed under the FSF documentation license
7	and/or the GPL, and we would like to leave open the possibility of
8	assigning copyright for the work to either SPI or the FSF, excluding
9	the parts which are copyrighted by Larry Greenfield.
10
11	YOU SHOULD HAVE READ THE GPL AND THE FSF DOCUMENTATION LICENSE, AND
12	BE COMFORTABLE WITH THEM. IF YOU ARE NOT, PLEASE DO NOT CONTRIBUTE
13	TO THIS MANUAL.
14
15	When writing it is VERY VERY important that you not refer to any document
16	with unknown copyright or a copyright other than the FSF documentation
17	license. Please do not copy even a single sentence verbatim from other
18	sources. Plagiarism will get us sued and ruin the possibility
19	of publishing this document. Note that trivial rewordings are not good
20	enough; you need to rewrite everything - new analogies, new structure,
21	new order of presentation, new content.
22
23	Thanks, and apologies that that is necessary. On to the interesting
24	stuff - please read this whole file.
25
26	------------------------
27
28	The files in this directory are meant to be updated by everyone. Feel
29	free to add your own notes to the notes files, and of course you'll
30	want to change the Tutorial source file.
31
32	Notes on the source file:
33
34	I'm using --- for dash, on the principle that it can be
35	search-and-replaced later if it's the wrong thing.
36
37	Put a FIXME when something's wrong, and we can grep for these
38	prior to public releases.
39
40	The chapter/section id's are hierarchical, to create "namespaces".
41
42	Emacs PSGML mode will screw up the <example></example> indentation.
43	These have to stay left-justified. So you can't indent the whole
44	document at once, you have to dodge the <example> parts. Fill will
45	also screw up the <example> sections, obviously.
46
47	"Configuration" chapters (mostly toward the end) have low priority,
48	these are supposed to be in the Installation Manual.
49
50	If in doubt, explain it. We're not paying for paper so be thorough. :)
51
52	If you're working on a chapter or section feel free to change around,
53	remove, add headings.
54
55	The use of <tt> vs. <prgn> is a little inconsistent. Probably ought to
56	be fixed.
57
58	<em> can be used to mark the first occurence of an important concept,
59	e.g. "this part of the system is called the <em>kernel</em>"
60
61	Note the '<enumlist> <item> <p> <tt>command </tt> <p> explanation'
62	format for tutorials. This is vastly inferior to DocBook. For now
63	we'll have to suck it up and deal.
64
65	If you make changes, please add to the ChangeLog. Emacs has a
66	ChangeLog mode that's nice. Otherwise copy the format of previous
67	entries.
68
69	You should read the section on keys and try to use the notation
70	described there. It's the same as the Emacs manual's notation.
71
72
73