website view en/devel/index.php @ rev 776
en: all new layout amd code clean-up
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Sat Mar 26 15:43:13 2011 +0100 (2011-03-26) |
| parents | |
| children | 551a11bab60a |
line source
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <title>SliTaz - Developers corner</title>
6 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
7 <meta name="description" content="SliTaz GNU/Linux project information overview" />
8 <meta name="keywords" lang="en" content="about slitaz, gnu, linux, mini distro, livecd" />
9 <meta name="robots" content="index, follow, all" />
10 <meta name="modified" content="<?php echo (date( "Y-m-d H:i:s", getlastmod())); ?>" />
11 <meta name="author" content="Christophe Lincoln"/>
12 <link rel="shortcut icon" href="../../favicon.ico" />
13 <link rel="stylesheet" type="text/css" href="../../slitaz.css" />
14 </head>
15 <body>
17 <!-- Header -->
18 <div id="header">
19 <div id="logo"></div>
20 <div id="network">
21 <a href="http://www.slitaz.org/netmap.php">
22 <img src="../../images/network.png" alt="network.png" /></a>
23 <a href="http://scn.slitaz.org/">Community</a>
24 <a href="http://doc.slitaz.org/">Doc</a>
25 <a href="http://forum.slitaz.org/">Forum</a>
26 <a href="http://labs.slitaz.org/issues">Bugs</a>
27 <a href="http://hg.slitaz.org/">Hg</a>
28 </div>
29 <h1><a href="http://www.slitaz.org/">SliTaz GNU/Linux</a></h1>
30 </div>
32 <!-- Block -->
33 <div id="block">
34 <!-- Navigation -->
35 <div id="block_nav">
36 <h4>Navigation</h4>
37 <div class="right_box">
38 <ul>
39 <li><a href="../mailing-list.html">Mailing List</a></li>
40 <li><a href="../devel/">Development</a></li>
41 <li><a href="../artwork/">Artwork</a></li>
42 <li><a href="../search.html">Search</a></li>
43 </ul>
44 </div>
45 <div class="left_box">
46 <ul>
47 <li><a href="../about/">About</a></li>
48 <li><a href="../get/">Download</a></li>
49 <li><a href="../asso/">Association</a></li>
50 <li><a href="../doc/">Documentation</a></li>
51 <li><a href="../packages/">Packages</a></li>
52 </ul>
53 </div>
54 </div>
55 <!-- Information/image -->
56 <div id="block_info">
57 <h4>Development</h4>
58 <p>
59 SliTaz is a community based distribution made by many
60 people all over the world and everyone is welcome to help
61 and get involve in the project.
62 </p>
63 <p>
64 <img src="../../images/users.png" alt="users.png" />
65 <a href="http://scn.slitaz.org/">Join us on SCN</a> and
66 the <a href="../mailing-list.html">mailing list</a>
67 </p>
68 </div>
69 </div>
71 <!-- Content -->
72 <div id="content">
74 <h2>Devel corner</h2>
76 <ul>
77 <li><a href="#devel">SliTaz Developers corner.</a></li>
78 <li><a href="#kiss">KISS and comply to standards.</a></li>
79 <li><a href="#tank">Build host & home.</a></li>
80 <li><a href="#repos">Mercurial repositories.</a></li>
81 <li><a href="#iconv">Implementation of iconv().</a></li>
82 <li><a href="#pkgs">Tazpkg packages.</a></li>
83 <li><a href="#website">Website Management.</a></li>
84 <!--<li><a href="#diff">Diff and patch files.</a></li>-->
85 </ul>
87 <a name="devel"></a>
88 <h2>SliTaz Developers corner</h2>
89 <p>
90 SliTaz is an open source and community driven distribution. Everyone is welcome
91 to join and contribute, from users, to hackers and developers, there is always
92 something to do, ie. Proofreading or writing documentation, sending bugs or
93 patches to the Mailing list, gaining access to the wok and pushing some new
94 packages or simply to help others on the Mailing list or forum. SliTaz has got
95 Mercurial repositories hosted on a SliTaz system, developers can ask for a new
96 repo if needed and contributors have write access to correct typos, scripts, etc.
97 </p>
98 <p>
99 SliTaz is a tiny community and listens to its users. There are several
100 developers who are active on the <a href="http://forum.slitaz.org/">forum</a>
101 and the <a href="../mailing-list.html">Mailing List</a>.
102 </p>
103 <p>
104 For artists there is a dedicated website, simply create an account and
105 post your graphics or pictures. The site is managed by the community. If
106 you want to lend a hand to administer the site, please contact a
107 contributor or e-mail the discussion list. The website art.slitaz.org:
108 <a href="http://art.slitaz.org/">SliTaz Community Art</a>
109 </p>
111 <a name="kiss"></a>
112 <h2>KISS and comply to standards</h2>
113 <p>
114 Keep it simple: follow the best standards, carefully draft and write
115 high quality documentation, provide a stable and robust system and keep
116 the <em>rootfs</em> on the LiveCD light enough to run on machines with at
117 least 128 MB RAM. It's also possible to use GTK+2, Dialog, SHell scripts,
118 or PHP coding tools on the distribution. The idea is not to duplicate and
119 to think small...
120 </p>
122 <a name="tank"></a>
123 <h2>Tank - Build host & home</h2>
124 <p>
125 Each contributor may have an account on the project server with secure
126 access, disk space, a public directory and all development tools.
127 Developers can compile packages and maintainers of the mirror can handle
128 sychronization. Tank also hosts the website, web boot and mercurial
129 repositories: <a href="http://tank.slitaz.org/">tank.slitaz.org</a>
130 </p>
131 <p>
132 Instructions on using the build host are described in the Cookbook:
133 <a href="http://doc.slitaz.org/en:cookbook:buildhost">SliTaz Build Host (tank)</a>.
134 </p>
136 <a name="repos"></a>
137 <h2>Mercurial repositories</h2>
138 <p>
139 SliTaz Mercurial or Hg repos can be browsed or cloned by anyone using the URL:
140 <a href="http://hg.slitaz.org/">http://hg.slitaz.org/</a>. People with write
141 access can directly use <code>repos.slitaz.org</code> which requires authentication.
142 Mercurial uses Python and is installable with:
143 <code>tazpkg get-install mercurial</code>
144 </p>
145 <h3>~/.hgrc</h3>
146 <p>
147 Before you push your first commit onto the server, be sure that you have a correct
148 Hg configuration file with your name and email address, and remember to check
149 that you are not root. Personal ~/.hgrc file example:
150 </p>
151 <pre class="script">
152 [ui]
153 username = FirstName LastName <you@example.org>
154 </pre>
155 <h4>Clone, modify, commit and push</h4>
156 <p>
157 Clone a repo, example for wok:
158 </p>
159 <pre>
160 $ hg clone http://repos.slitaz.org/wok
161 </pre>
162 <p>
163 Change directory to wok, note you must be in the repository to be able
164 to use 'hg' commands. To check all logs or just the last log:
165 </p>
166 <pre>
167 $ hg log
168 $ hg head
169 </pre>
170 <p>
171 Add or modify one or more files and commit:
172 </p>
173 <pre>
174 $ hg add
175 $ hg status
176 $ hg commit -m "Log message..."
177 $ hg log
178 </pre>
179 <p>
180 Note that you can use the command <code>rollback</code> to roll back to the last
181 transaction. Before pushing changes to the server, it is safe to pull once:
182 </p>
183 <pre>
184 $ hg pull
185 $ hg push
186 </pre>
187 <p>
188 Done, your changes, code or corrections are now on the server.
189 </p>
190 <h4>Updating a local wok</h4>
191 <p>
192 To update your wok with the local server (<em>pull</em> to pull the changes):
193 </p>
194 <pre>
195 $ hg pull
196 $ hg update
197 </pre>
198 <h4>Useful commands</h4>
199 <p>
200 Hg commands that can be used.
201 </p>
202 <ul>
203 <li><code>hg help</code> : Display the full list of commands.</li>
204 <li><code>hg rollback</code> : Undo the last action performed (commit,
205 pull, push).</li>
206 <li><code>hg log <package></code> : Display a package log.</li>
207 <li><code>hg head</code> : Display the last log.</li>
208 </ul>
210 <a name="iconv"></a>
211 <h2>Implementation of iconv()</h2>
212 <p>
213 SliTaz uses iconv() provided by GNU glibc - any packages that offer
214 <code>libiconv</code> must use the library contained in <code>glibc-locale</code>.
215 There is therefore no longer a libiconv package (1.2 MB) in SliTaz.
216 </p>
218 <a name="pkgs"></a>
219 <h2>Tazpkg Packages</h2>
220 <p>
221 The tazpkg packages in SliTaz are automatically created via Tazwok and a
222 receipt in the wok. The Cookbook describes the
223 <a href="../doc/cookbook/wok-tools.html">use of tools</a>
224 and the format of <a href="../doc/cookbook/receipts.html">receipts</a>.
225 These are required reading before we begin.
226 </p>
227 <p>
228 In terms of choice of package, the idea is to offer a package by task or
229 functionality, ie. the lightest application in the field and not duplicated.
230 Note that the current packages are not immutable, if you find an alternative
231 that is lighter, with more features or more <em>sexy</em> for a few extra KB,
232 you can suggest it on the Mailing List. Particular attention is given to
233 packages for the LiveCD, these should be stripped, removing unnecesary
234 dependancies and compiler options. In general candidate packages for the core
235 LiveCD are discussed on the Mailing List.
236 </p>
237 <p>
238 Before you begin to compile and create packages for SliTaz, be sure that the
239 work doesn't already exist in the
240 <a href="http://download.tuxfamily.org/slitaz/packages/undigest/">undigest</a>
241 wok provided by the primary SliTaz mirror. Don't forget that the members
242 of the list are there to help you and that the documentation of the
243 <a href="../doc/cookbook/wok-tools.html">wok and tools</a>
244 exists to help you get started.
245 </p>
247 <a name="pkgs-naming"></a>
248 <h3>Naming of packages</h3>
249 <p>
250 In most cases the package name is the same as the source, except for
251 Python, Perl, PHP, Ruby and Lua modules. For example, the package
252 providing a Kid template system written in Python and XML is named:
253 <code>python-kid</code>.
254 </p>
256 <a name="website"></a>
257 <h2>Website Management</h2>
258 <p>
259 The website is managed via a mercurial repository, they can be cloned by:
260 </p>
261 <pre>
262 $ hg clone http://hg.slitaz.org/website
263 Or if you have the proper permissions:
264 $ hg clone http://repos.slitaz.org/website
265 </pre>
267 <h3>xHTML coding style</h3>
268 <p>
269 The pages and different <em>books</em> are coded in xHTML 1.0
270 transitional. The title of level 1 is used only once (at the top),
271 level 2 is the title of the document and levels 3 and 4 are then used for
272 the subtitles. If a list is used instead using smart anchors;
273 then that starts at the top, just after the title of level 2.
274 Paragraphs are contained in the tags <code><p></p></code>.
275 For indentation, we use tabs - the reason being semantics and to take
276 up less space in terms of octets (bytes). To put code, like the name of
277 a command inside a paragraph: <code><code></code> is the preferred
278 method. To view commands or to utilize a terminal, the web pages use
279 <code><pre></code> to display the formatted text. Example:
280 </p>
281 <pre>
282 $ command
283 </pre>
284 <p>
285 To view text that can be copied and pasted, such as scripts,
286 bits of code, sample configuration files, etc - we also use
287 <code><pre></code>, but with a CSS class named "script". Example:
288 </p>
289 <pre class="script">
290 <pre class="script">
292 code...
294 </pre>
295 </pre>
296 <p>
297 The <em>emphasized</em> words put themselves in the tag <code><em></code>
298 and internal links are relative. Remember to check the validity
299 of the code via the online <em>validator</em> of the W3C.
300 </p>
302 <a name="diff"></a>
303 <h2>Diff and patch</h2>
304 <p>
305 The utilities <code>diff</code> and <code>patch</code> are command-line tools
306 for creating and implementing a file containing differences between two files.
307 This technique is often used for collaboration and the changes made to the
308 original file can be clearly extracted. To create a <code>diff</code> file
309 readable by humans in a simple text editor, you must supply the <code>-u</code> option:
310 </p>
311 <pre>
312 $ diff -u file.orig file.new > file.diff
313 </pre>
314 <p>
315 To apply a patch:
316 </p>
317 <pre>
318 $ patch file.orig file.diff
319 </pre>
321 <!-- End of content -->
322 </div>
324 <!-- Footer -->
325 <div id="footer">
326 Copyright © <span class="year"></span>
327 <a href="http://www.slitaz.org/">SliTaz</a> - Network:
328 <a href="http://scn.slitaz.org/">Community</a>
329 <a href="http://doc.slitaz.org/">Doc</a>
330 <a href="http://forum.slitaz.org/">Forum</a>
331 <a href="http://pkgs.slitaz.org/">Packages</a>
332 <a href="http://labs.slitaz.org/issues">Bugs</a>
333 <a href="http://hg.slitaz.org/">Hg</a>
334 <p>
335 SliTaz @
336 <a href="http://twitter.com/slitaz">Twitter</a>
337 <a href="http://www.facebook.com/slitaz">Facebook</a>
338 <a href="http://distrowatch.com/slitaz">Distrowatch</a>
339 <a href="http://en.wikipedia.org/wiki/SliTaz">Wikipedia</a>
340 <a href="http://flattr.com/profile/slitaz">Flattr</a>
341 </p>
342 </div>
344 </body>
345 </html>