website view en/devel/forge.php @ rev 922
en: Move more pages to PHP and add lib/html/social.html
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Sun Mar 11 22:54:13 2012 +0100 (2012-03-11) |
| parents | f2f7758d9a72 |
| children | 4c3ed2170e2e |
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 - Forge (en)</title>
6 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
7 <meta name="description" content="slitaz developers forge" />
8 <meta name="keywords" lang="en" content="slitaz, devel, hg, bugs" />
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 <?php include("../../lib/html/header.html"); ?>
19 <!-- Block -->
20 <div id="block">
21 <?php include("../../lib/html/nav.en.html"); ?>
22 <!-- Information/image -->
23 <div id="block_info">
24 <h4>Forge</h4>
25 <p>
26 Misc tools, guidelines and services used to create and build SliTaz.
27 </p>
28 <p>
29 <img src="../../images/users.png" alt="users.png" />
30 <a href="http://scn.slitaz.org/">Join us on SCN</a> and
31 the <a href="../mailing-list.php">mailing list</a>
32 </p>
33 </div>
34 </div>
36 <!-- Content -->
37 <div id="content">
39 <h2>Collaborative management</h2>
41 <ul>
42 <li><a href="#kiss">KISS and comply to standards.</a></li>
43 <li><a href="#tank">Build host & home.</a></li>
44 <li><a href="#repos">Mercurial repositories.</a></li>
45 <li><a href="#gui">GUI in GTK and CGI/web</a></li>
46 <li><a href="#iconv">Implementation of iconv().</a></li>
47 <li><a href="#pkgs">Tazpkg packages.</a></li>
48 <li><a href="#website">Website Management.</a></li>
49 </ul>
51 <a name="kiss"></a>
52 <h2>KISS and comply to standards</h2>
53 <p>
54 Keep it simple: follow the best standards, carefully draft and write
55 high quality documentation, provide a stable and robust system and keep
56 the <em>rootfs</em> on the LiveCD light enough to run on machines with at
57 least 128 MB RAM. It's also possible to use GTK+2, Dialog, SHell scripts,
58 or PHP coding tools on the distribution. The idea is not to duplicate and
59 to think small...
60 </p>
62 <a name="tank"></a>
63 <h2>Tank - Build host & home</h2>
64 <p>
65 Each contributor may have an account on the project server with secure
66 access, disk space, a public directory and all development tools.
67 Developers can compile packages and maintainers of the mirror can handle
68 sychronization. Tank also hosts the website, web boot and mercurial
69 repositories: <a href="http://tank.slitaz.org/">tank.slitaz.org</a>
70 </p>
71 <p>
72 Instructions on using the build host are described in the Cookbook:
73 <a href="http://doc.slitaz.org/en:cookbook:buildhost">
74 SliTaz Build Host (tank)</a>.
75 </p>
77 <a name="repos"></a>
78 <h2>Mercurial repositories</h2>
79 <p>
80 SliTaz Mercurial or Hg repos can be browsed or cloned by anyone using
81 the URL: <a href="http://hg.slitaz.org/">http://hg.slitaz.org/</a>. People
82 with write access can directly use <code>repos.slitaz.org</code> which
83 requires authentication. Mercurial uses Python and is installable with:
84 <code>tazpkg get-install mercurial</code>
85 </p>
87 <h3>~/.hgrc</h3>
88 <p>
89 Before you push your first commit onto the server, be sure that you have a
90 correct Hg configuration file with your name and email address, and remember
91 to check that you are not root. Personal ~/.hgrc file example:
92 </p>
93 <pre class="script">
94 [ui]
95 username = FirstName LastName <you@example.org>
96 </pre>
97 <h4>Clone, modify, commit and push</h4>
98 <p>
99 Clone a repo, example for wok:
100 </p>
101 <pre>
102 $ hg clone http://repos.slitaz.org/wok
103 </pre>
104 <p>
105 Change directory to wok, note you must be in the repository to be able
106 to use 'hg' commands. To check all logs or just the last log:
107 </p>
108 <pre>
109 $ hg log
110 $ hg head
111 </pre>
112 <p>
113 Add or modify one or more files and commit:
114 </p>
115 <pre>
116 $ hg add
117 $ hg status
118 $ hg commit -m "Log message..."
119 $ hg log
120 </pre>
121 <p>
122 Note that you can use the command <code>rollback</code> to roll back to the last
123 transaction. Before pushing changes to the server, it is safe to pull once:
124 </p>
125 <pre>
126 $ hg pull
127 $ hg push
128 </pre>
129 <p>
130 Done, your changes, code or corrections are now on the server.
131 </p>
132 <h4>Updating a local wok</h4>
133 <p>
134 To update your wok with the local server (<em>pull</em> to pull the changes):
135 </p>
136 <pre>
137 $ hg pull -u
138 </pre>
139 <h4>Useful commands</h4>
140 <p>
141 Hg commands that can be used.
142 </p>
143 <ul>
144 <li><code>hg help</code> : Display the full list of commands.</li>
145 <li><code>hg rollback</code> : Undo the last action performed (commit,
146 pull, push).</li>
147 <li><code>hg log <package></code> : Display a package log.</li>
148 <li><code>hg head</code> : Display the last log.</li>
149 </ul>
151 <a name="gui"></a>
152 <h2>GUI - Pure C/GTK, Yad, Vala/Genie and CGI/web</h2>
154 <p>
155 There are many ways to create user interfaces in the open source world. From
156 the start of the project until 3.0 we mainly used a tool called Gtkdialog
157 which let us create quite nice and complex interfaces in GTK, but using a
158 scripting language that just run without having to be compiled. But gtkdialog is
159 unmaintained and lacks many new GTK features, so we switched to Yad for simple GUI boxes.
160 For all the administration, packages and configuration tools we switched to TazPanel,
161 a CGI/web interface with a gui coded in xHTML 5 and CSS 3.
162 </p>
163 <p>
164 Yad is very simple but doesn't allow us to create complex interfaces even if we
165 only need 2 or 3 entries with labels and a few buttons, so another way
166 must be found. The advantage of a scripting language is the fact that it doesn't need
167 to be compiled and can be coded in realtime (but it produces slower applications).
168 Writing tools in C is complex and gets less contributions since SHell scripts are easier
169 to understand, so the guidelines are now to keep and continue to improve our
170 cmdline tools and provide frontends in GTK or CGI/web.
171 </p>
172 <p>
173 There are many new languages that use GTK such as Genie, Vala or GTKaml.
174 But keep in mind that they are not as popular as C and GTK and not really
175 easier to learn and use (for simple frontends you can use SHell
176 scripts to perform tasks). You can use Vala but look at a pure
177 GTK single window, it uses only 14 lines:
178 </p>
179 <pre>
180 #include <gtk/gtk.h>
182 int main(int argc, char *argv[])
183 {
184 GtkWidget *window;
186 gtk_init(&argc, &argv);
187 window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
188 g_signal_connect (G_OBJECT (window), "destroy",
189 G_CALLBACK (gtk_main_quit), NULL);
191 gtk_widget_show(window);
192 gtk_main();
193 return 0;
194 }
195 </pre>
196 <p>
197 If you are not sure about which language to use, discuss it on the mailing list.
198 If you just want a small GUI function, look at tazbox in the slitaz-tools
199 repo, it has tiny desktop tools such as a logout box. The first
200 SliTaz sub-project written in pure GTK is TazWeb and you can use it to learn
201 ways to use system() to include system commands in your frontend. For
202 example TazWeb uses wget for downloads and sed to add bookmarks.
203 </p>
204 <p>
205 Yad scripts should follow TazYad guidelines:
206 <a href="http://hg.slitaz.org/slitaz-dev-tools/raw-file/tip/tazyad/README">
207 README</a> and
208 <a href="http://hg.slitaz.org/slitaz-dev-tools/raw-file/tip/tazyad/tazyad">
209 example code</a>
210 </p>
212 <a name="iconv"></a>
213 <h2>Implementation of iconv()</h2>
214 <p>
215 SliTaz uses iconv() provided by GNU glibc - any packages that offer
216 <code>libiconv</code> must use the library contained in <code>glibc-locale</code>.
217 There is therefore no longer a libiconv package (1.2 MB) in SliTaz.
218 </p>
220 <a name="pkgs"></a>
221 <h2>Tazpkg Packages</h2>
222 <p>
223 The tazpkg packages in SliTaz are automatically created via Tazwok and a
224 receipt in the wok. The Cookbook describes the
225 <a href="http://doc.slitaz.org/en:cookbook:wok">use of tools</a>
226 and the format of <a href="http://doc.slitaz.org/en:cookbook:receipt">receipts</a>.
227 These are required reading before we begin.
228 </p>
229 <p>
230 In terms of choice of package, the idea is to offer a package by task or
231 functionality, ie. the lightest application in the field and not duplicated.
232 Note that the current packages are not immutable, if you find an alternative
233 that is lighter, with more features or more <em>sexy</em> for a few extra KB,
234 you can suggest it on the Mailing List. Particular attention is given to
235 packages for the LiveCD, these should be stripped, removing unnecesary
236 dependencies and compiler options. In general candidate packages for the core
237 LiveCD are discussed on the Mailing List.
238 </p>
239 <p>
240 Before you begin to compile and create packages for SliTaz, be sure that the
241 work doesn't already exist in the
242 <a href="http://download.tuxfamily.org/slitaz/packages/undigest/">undigest</a>
243 wok provided by the primary SliTaz mirror. Don't forget that the members
244 of the list are there to help you and that the documentation of the
245 <a href="http://doc.slitaz.org/en:cookbook:wok">wok and tools</a>
246 exists to help you get started.
247 </p>
249 <a name="pkgs-naming"></a>
250 <h3>Naming of packages</h3>
251 <p>
252 In most cases the package name is the same as the source, except for
253 Python, Perl, PHP, Ruby and Lua modules. For example, the package
254 providing a Kid template system written in Python and XML is named:
255 <code>python-kid</code>.
256 </p>
258 <a name="website"></a>
259 <h2>Website Management</h2>
260 <p>
261 The website is managed via a mercurial repository, they can be cloned by:
262 </p>
263 <pre>
264 $ hg clone http://hg.slitaz.org/website
265 Or if you have the proper permissions:
266 $ hg clone http://repos.slitaz.org/website
267 </pre>
269 <h3>xHTML coding style</h3>
270 <p>
271 The pages and different <em>books</em> are coded in xHTML 1.0
272 transitional. The title of level 1 is used only once (at the top),
273 level 2 is the title of the document and levels 3 and 4 are then used for
274 the subtitles. If a list is used instead using smart anchors;
275 then that starts at the top, just after the title of level 2.
276 Paragraphs are contained in the tags <code><p></p></code>.
277 For indentation, we use tabs - the reason being semantics and to take
278 up less space in terms of octets (bytes). To put code, like the name of
279 a command inside a paragraph: <code><code></code> is the preferred
280 method. To view commands or to utilize a terminal, the web pages use
281 <code><pre></code> to display the formatted text. Example:
282 </p>
283 <pre>
284 $ command
285 </pre>
286 <p>
287 To view text that can be copied and pasted, such as scripts,
288 bits of code, sample configuration files, etc - we also use
289 <code><pre></code>, but with a CSS class named "script". Example:
290 </p>
291 <pre class="script">
292 <pre class="script">
294 code...
296 </pre>
297 </pre>
298 <p>
299 The <em>emphasized</em> words put themselves in the tag <code><em></code>
300 and internal links are relative. Remember to check the validity
301 of the code via the online <em>validator</em> of the W3C.
302 </p>
304 <a name="diff"></a>
305 <h2>Diff and patch</h2>
306 <p>
307 The utilities <code>diff</code> and <code>patch</code> are command-line tools
308 for creating and implementing a file containing differences between two files.
309 This technique is often used for collaboration and the changes made to the
310 original file can be clearly extracted. To create a <code>diff</code> file
311 readable by humans in a simple text editor, you must supply the <code>-u</code> option:
312 </p>
313 <pre>
314 $ diff -u file.orig file.new > file.diff
315 </pre>
316 <p>
317 To apply a patch:
318 </p>
319 <pre>
320 $ patch file.orig file.diff
321 </pre>
323 <!-- End of content -->
324 </div>
326 <?php include("../../lib/html/footer.html"); ?>
328 </body>
329 </html>