| [ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This Documentation is not maintained by a single person. Instead, everybody is invited to write a new chapter or a (sub)section to some existing chapter. Each article consists of the name of the chapter or section in the first line, followed by the article text in texinfo format. To submit the article to the Documentation Project, it must be uploaded by anonymous FTP into a secure upload directory. Please note that everyone can overwrite existing texts, thus be very careful that you don't overwrite the article from someone else. Always keep your own copy of the article so that you can transfer it again in case someone deleted your contribution by accident.
Every article that is contributed must start with the line
@section name_of_section |
The file must be written in Texinfo Format. You don't need to know much about Texinfo to write articles. Even a plain text file with just one section line added will work, although it may not look very nice. If you want to add more sections and subsections, the commands are:
@section @subsection @subsubsection @heading @subheading |
Please note that the article should always start with @section, regardless of the actual level, because the actual level in the document hierarchy is automatically determined by the upload filename.
The files must be uploaded to uldp.home.at, username ftp. Please use your e-mail address as password. When you cd to the directory `uldp', a list of existing articles appears:
01 First chapter 01.01 Section 1 of the first chapter 01.01.10 This is a subsection 01.02 Section 2 of the first chapter |
Thus the filename consists of one to three numbers with exactly two digits. The leading zeros are important because the sections are sorted by filename. So, if you want to submit a new section for the first chapter, you may upload it as 01.03 in the example given above. Please be really careful that you don't overwrite existing files. The table that is shown when the directory is entered may be not up to date, because it is updated by a cron job when the new html output is generated. It is not possible to download the files that are in the directory to prevent misuse of the ftp server. Please do a directory listing first before you upload your file.
Use your favorite editor to create a text file. If you use emacs, there's a Texinfo mode that will make it easier to write Texinfo files.
@section Q: Some new question for the FAQ The short answer is here. As you can see, it's really easy to write a new article. @section Q: Just another FAQ entry This section has been added to show that it is possible to submit multiple sections in the same file. |
... ftp> cd uldp 250-01 @section The Open uClinux Documentation Project 250-02 @section FAQs 250-02.01 @section The M68EZ328ADS board FAQ 250-02.01.01 @section Q: I am having trouble compiling uClinux-2.0.38.1pre7 for M68EZ328ADS. 250 CWD command successful. |
Before the new article is uploaded, it should be verified that there is really no file 02.01.02 that might have been uploaded, unless you want to overwrite an old version of your own file. Then, switch to ascii mode transfer and upload the file. That's all. Your new entries will appear in the HTML document soon.
ftp> dir 200 PORT command successful. 150 Opening ASCII mode data connection for file list. -rw-r--r-- 1 ftp nogroup 2625 May 25 18:54 01 -rw-r--r-- 1 ftp nogroup 15 May 25 19:09 02 -rw-r--r-- 1 ftp nogroup 165 May 25 19:09 02.01 -rw-r--r-- 1 ftp nogroup 6913 May 25 18:04 02.01.01 226-Transfer complete. 226 Quotas off ftp> asc 200 Type set to A. ftp> put (local-file) article.txt (remote-file) 02.01.02 local: article.txt remote: 02.01.02 200 PORT command successful. 150 Opening ASCII mode data connection for 02.01.02. 226 Transfer complete. 363 bytes sent in 0.00 secs (1568.5 kB/s) ftp> bye |
| [ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |