-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathautobooks.TODO
150 lines (117 loc) · 4.55 KB
/
autobooks.TODO
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
named this job : autobooks
NAMING CONVENTIONS
module: A module is a collection of docbook .xml files that reside in a module-directory.
module-directory: A module-directory is a sub directory of /modules who's name starts with mod_.
chapter: A chapter is defined by the <chapter></chapter> tag in docbook xml.
minibook: A collection of modules that belong tightly together. Can be built as a minibook.pdf file.
book: Either a minibook, or a collection of minibooks.
GOALS:
- FIXED obsolete the 'chapters' file (using a script that reads xml files in module-directories alphabetically)
- FIXED integrate the <part> tag into the docbook xml
- FIXED allow for smaller books (minibooks) that handle one topic
- build the larger (existing) books with these minibooks
- be able to build separate books for theory (and practice?) with a separate solution?
ADDITIONAL GOALS:
- FIXED create a one-to-one relation between modules and chapters
HOW:
1. module-directories are processed alphabetically by the new build script
Most module-directories now have files named like this:
010_$string_title
020_$string_about (optional)
030_$string_theory
040_$string_practice (optional)
050_$string_solution (optional)
FIXED paul renamed xml files in the module-directories to match this system
(some modules divert from this, but can be processed alphabetically now!)
FIXED serge can write a script to parse a module-directory instead of the 'chapters' file
2. minibooks can be a single book in xml <book></book>
Minibooks have their own directory in /books/minibook_name_of_minibook/
Some minibooks are defined already.
3. minibooks become parts in xml <part></part> when bundled in a book
FIXED paul has prepared some minibooks in 'experimental branch' so serge can test his script
EXTRA:
This system has the potential to add a 020_$string_about file in the mod_ directory. This xml file can serve as an introductory page to each chapter, and can also serve as a means for clients to customize the course (by chapter) based on the content of this introduction.
Paul really likes this idea because :
- it can reduce the book-toc to 1 line per chapter
- it can be used commercially to give "sales-people" a readable technical content to present to potential clients
- it would remove the (imho silly) toc per chapter
- it can be used while teaching to introduce the topic to students
CURRENT ACTIONS
FIXED - paul: create first minibook and notify serge when committed in experimental (done)
- paul: continues with the other minibooks (and minichapters) (working)
FIXED - serge: update the built project so it can parse module-directories without the chapters file
ISSUES
- some chapters are not split without extra work synchronizing practices with theory (will be done when pdf's can be built to check outcome)
- some chapters (like the introduction) are not easily split and require quite some rewriting (same as above)
- (minor issue) pagebreaks are currently hardcoded in the xml files. Each xml file starts with a page break, unless it immediately follows a chapter title
...potential LAYOUT of minibooks
--------------------------------
minibook : introduction (DONE)
- unix history
- licensing/philosophy
- distributions
- certification (maybe this should be an appendix)
- installing Linux (NEW)
- online help
minibook : first steps (DONE)
- man pages
- working with directories
- working with files
- working with file contents
- the Linux file tree
minibook : the shell (DONE)
- arguments
- control operators
- variables
- file globbing
- shell history
minibook : pipes and commands (DONE)
- i/o redirection
- filter commands
- common tools
- compression
minibook : vi (TO BE SPLIT)
- vi(m)
minibook : scripting (TO BE REVIEWED)
- introduction to scripting
- tests and loops
- parameters and options
- more scripting
minibook : user management (TO BE REVIEWED)
- users
- passwords
- user environment
- su and sudo
- groups
minibook : files (DONE)
- basic permissions
- advanced permissionsa
- access control lists
- extended attributes (NEW TO DO)
- file links (right?)
minibook : processes
- ... we 'll see when we get here
TODO minibooks for system administration
TODO minibooks for the advanced/server topics
TODO minibooks for the end user training in Dutch (eindgebruikers Linux)
TODO minibooks for the tcp/ip course for SyntraAB
XML LAYOUT OF MINIBOOK:
<book>
bookheader
booktoc
<chapter> module </chapter>
...
<chapter> module </chapter>
gnu license
index
</book>
XML LAYOUT OF BOOK:
<book>
bookheader
booktoc with parts
<part>minibook chapters</part>
...
<part>minibook chapters</part>
gnu license
index
</book>