1 | <? |
---|
2 | |
---|
3 | |
---|
4 | |
---|
5 | // |
---|
6 | |
---|
7 | // File : index.php |
---|
8 | |
---|
9 | // Version : $Id: index.php,v 1.22 2003/05/08 00:03:43 landonf Exp $ |
---|
10 | |
---|
11 | // Location : /projects/doc/index.php |
---|
12 | |
---|
13 | // |
---|
14 | |
---|
15 | |
---|
16 | |
---|
17 | include_once("$DOCUMENT_ROOT/includes/od_lib.inc.php"); |
---|
18 | |
---|
19 | od_print_header("doc", "en", "iso-8859-1", "", 0, "/projects/doc"); |
---|
20 | |
---|
21 | ?> |
---|
22 | |
---|
23 | |
---|
24 | |
---|
25 | <center> |
---|
26 | |
---|
27 | <table border="0" width="500" cellspacing="0" cellpadding="3"> |
---|
28 | |
---|
29 | <tr><td> |
---|
30 | |
---|
31 | |
---|
32 | |
---|
33 | <h2>Projects :: doc</h2> |
---|
34 | |
---|
35 | |
---|
36 | |
---|
37 | <p> |
---|
38 | |
---|
39 | <a name="contacts"><i>Project Contacts: </i></a><br> |
---|
40 | |
---|
41 | <a href="mailto:jim%40opendarwin.org">Jim Mock</a>, Coordinator <br> |
---|
42 | |
---|
43 | <a href="mailto:eric%40opendarwin.org">Eric Albert</a>, Editor <br> |
---|
44 | |
---|
45 | <a href="mailto:kevin%40opendarwin.org">Kevin Van Vechten</a>, CVS Administrator <br> |
---|
46 | |
---|
47 | <a href="http://www.opendarwin.org/mailman/listinfo/doc">Doc@OpenDarwin.org</a>, Team Mailing List <br> |
---|
48 | |
---|
49 | <a href="http://www.opendarwin.org/mailman/listinfo/cvs-doc-all">cvs-Doc-all@OpenDarwin.org</a>, CVS Mailing List <br> |
---|
50 | |
---|
51 | </p> |
---|
52 | |
---|
53 | |
---|
54 | |
---|
55 | <p> |
---|
56 | |
---|
57 | The OpenDarwin documentation project ("Doc") creates and manages tools and content for documenting Darwin, OpenDarwin, and DarwinPorts. Current resources (links coming soon) include: |
---|
58 | |
---|
59 | <ul> |
---|
60 | |
---|
61 | <li>How-Tos |
---|
62 | |
---|
63 | <li>Makefiles for generating HTML from DocBook XML (via ports system libxstl) |
---|
64 | |
---|
65 | <li>Documentation Style Guide |
---|
66 | |
---|
67 | <li>Porting User Guide |
---|
68 | |
---|
69 | <li>Darwinports How-Tos |
---|
70 | |
---|
71 | <li>DarwinPorts FAQ |
---|
72 | |
---|
73 | <li>OpenDarwin FAQ |
---|
74 | |
---|
75 | </ul> |
---|
76 | |
---|
77 | </p> |
---|
78 | |
---|
79 | <p> |
---|
80 | |
---|
81 | We also work closely with the "www" project (responsible for the overall <a href="http://opendarwin.org/">web site</a> and <a href="http://opendarwin.org/bugzilla/">Bugzilla</a>), as well as the individual <a href="http://opendarwin.org/projects/">project</a> web teams. In general, the Doc project contains anything written in DocBook XML, whereas www contains HTML/PHP/CGI content, and man pages live with the source code. |
---|
82 | |
---|
83 | </p> |
---|
84 | |
---|
85 | |
---|
86 | |
---|
87 | <p><strong>Project Status</strong></p> |
---|
88 | |
---|
89 | <p> |
---|
90 | |
---|
91 | We have just started populating the CVS repository. Current action items are: |
---|
92 | |
---|
93 | <ul> |
---|
94 | |
---|
95 | <li> Translate all /doc content into DocBook XML: Dave Leimbach |
---|
96 | |
---|
97 | <li> Automate XML build into site push: <a href="mailto:kevin%40opendarwin.org">Kevin</a> |
---|
98 | |
---|
99 | <li> Email members & process for CVS commits: <a href="mailto:kevin%40opendarwin.org">Kevin</a> |
---|
100 | |
---|
101 | <li>DarwinPorts flyer: <a href="mailto:fkr%40opendarwin.org">Felix Kronlage</a> |
---|
102 | |
---|
103 | <li>User Guide: |
---|
104 | |
---|
105 | <ul> |
---|
106 | |
---|
107 | <li>(a) Merge Portfile How-To: <a href="mailto:wb%40willbarton.com">Will Barton</a> |
---|
108 | |
---|
109 | <li>(b) Add "test & debug" chapter: <a href="mailto:allenwc%40shaw.ca">Liam Allen</a> |
---|
110 | |
---|
111 | </ul> |
---|
112 | |
---|
113 | </ul> |
---|
114 | |
---|
115 | |
---|
116 | |
---|
117 | <p> |
---|
118 | |
---|
119 | Of course, there is much more to be done, and all of these people would welcome help. |
---|
120 | |
---|
121 | Your contributions (new content, corrections, related links) are very much welcomed! If interested, send an e-mail to one of our <a href="#contacts">contacts</a> asking what needs to be done or simply submit an application to <a href="/en/joinproject.php">join the project</a>. Thanks! |
---|
122 | |
---|
123 | </p> |
---|
124 | |
---|
125 | |
---|
126 | |
---|
127 | <p><strong>Getting the project from CVS</strong></p> |
---|
128 | |
---|
129 | |
---|
130 | |
---|
131 | <p> |
---|
132 | |
---|
133 | </p> |
---|
134 | |
---|
135 | |
---|
136 | |
---|
137 | <p> |
---|
138 | |
---|
139 | <pre> |
---|
140 | |
---|
141 | cvs -d :pserver:anonymous@anoncvs.opendarwin.org:/Volumes/src/cvs/od login |
---|
142 | |
---|
143 | cvs -d :pserver:anonymous@anoncvs.opendarwin.org:/Volumes/src/cvs/od co -P doc |
---|
144 | |
---|
145 | </pre> |
---|
146 | |
---|
147 | |
---|
148 | |
---|
149 | When the server asks you for a password you can simply hit return; the password is empty. |
---|
150 | |
---|
151 | The CVS repository can be browsed through the <a href="http://www.opendarwin.org/cgi-bin/cvsweb.cgi/doc/">CVSweb</a> interface. |
---|
152 | |
---|
153 | </p> |
---|
154 | |
---|
155 | |
---|
156 | |
---|
157 | <p> |
---|
158 | |
---|
159 | In order to run the Makefiles to generate HTML, the Mac OS X <a href="http://developer.apple.com/tools/">Developer Tools</a> must be installed. |
---|
160 | |
---|
161 | </p> |
---|
162 | |
---|
163 | <p> |
---|
164 | |
---|
165 | After installing the developer tools, and the darwinports system<br> |
---|
166 | |
---|
167 | you will need to install the libxslt port, the docbook-xml port, and the docbook-xsl port. |
---|
168 | |
---|
169 | </p> |
---|
170 | |
---|
171 | <p>at the command prompt type: |
---|
172 | |
---|
173 | <code>% sudo port install libxslt</code>, |
---|
174 | |
---|
175 | this will install libxslt and its dependencies.<br> |
---|
176 | |
---|
177 | you just do the same for the other two ports.<br> |
---|
178 | |
---|
179 | Then you are all ready to go. |
---|
180 | |
---|
181 | </p> |
---|
182 | |
---|
183 | <p> |
---|
184 | |
---|
185 | To use libxslt to generate the xhtml you will need to change to the directory of the document you are editing or altering and run <code>% make xhtml</code>. This will create the xhtml subdir and populate it with the generated html files. It will also inform you of errors in your xml style. |
---|
186 | |
---|
187 | </p> |
---|
188 | |
---|
189 | |
---|
190 | |
---|
191 | <p><strong>Links on this page</strong></p> |
---|
192 | |
---|
193 | <a href="http://www.opendarwin.org/cgi-bin/cvsweb.cgi/doc/">CVSweb</a><br> |
---|
194 | |
---|
195 | <a href="/en/joinproject.php">join the project</a><br> |
---|
196 | |
---|
197 | <a href="http://developer.apple.com/tools/">Developer Tools</a><br> |
---|
198 | |
---|
199 | <a href="http://opendarwin.org/projects/">project</a> web teams<br> |
---|
200 | |
---|
201 | <a href="http://www.opendarwin.org/mailman/listinfo/cvs-doc-all"> |
---|
202 | |
---|
203 | cvs-Doc-all@OpenDarwin.org</a>, CVS Mailing List <br> |
---|
204 | |
---|
205 | <a href="http://www.opendarwin.org/mailman/listinfo/doc"> |
---|
206 | |
---|
207 | Doc@OpenDarwin.org</a>, Team Mailing List<br> |
---|
208 | |
---|
209 | </p> |
---|
210 | |
---|
211 | |
---|
212 | |
---|
213 | </td></tr> |
---|
214 | |
---|
215 | </table> |
---|
216 | |
---|
217 | </center> |
---|
218 | |
---|
219 | |
---|
220 | |
---|
221 | |
---|
222 | |
---|
223 | <? |
---|
224 | |
---|
225 | od_print_footer("en"); |
---|
226 | |
---|
227 | ?> |
---|
228 | |
---|