mirror of https://github.com/tLDP/LDP
155 lines
10 KiB
XML
155 lines
10 KiB
XML
<?xml version='1.0' encoding='ISO-8859-1' ?>
|
|
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
|
<article class="faq">
|
|
<articleinfo>
|
|
<title>Linux Documentation Project (LDP) FAQ</title>
|
|
<author>
|
|
<firstname>Rahul</firstname>
|
|
<surname>Sundaram</surname>
|
|
<affiliation>
|
|
<address>
|
|
<email>rahulsundaram AT yahoo DOT co DOT in</email>
|
|
</address>
|
|
</affiliation>
|
|
</author>
|
|
|
|
<pubdate>February 2003</pubdate>
|
|
|
|
<revhistory>
|
|
<revision>
|
|
<revnumber>1.1</revnumber>
|
|
<date>2003-11-07</date>
|
|
<revremark>
|
|
Minor update
|
|
</revremark>
|
|
</revision>
|
|
</revhistory>
|
|
|
|
<revhistory>
|
|
<revision>
|
|
<revnumber>1.0</revnumber>
|
|
<date>2003-02-24</date>
|
|
<revremark>
|
|
Initial Release, reviewed by LDP
|
|
</revremark>
|
|
</revision>
|
|
</revhistory>
|
|
|
|
<legalnotice id="legalnotice">
|
|
<para>© 2003, Rahul Sundaram</para>
|
|
<blockquote>
|
|
<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no invariant sections, with no Front-Cover Texts,with no Back-Cover Text. A copy of the license is located at <ulink url="http://www.gnu.org/licenses/fdl.html" />.</para>
|
|
</blockquote>
|
|
</legalnotice>
|
|
|
|
<abstract>
|
|
<para>An introductory FAQ for users who come across the LDP and want a short introduction to it.
|
|
</para>
|
|
</abstract>
|
|
</articleinfo>
|
|
|
|
<qandaset defaultlabel='qanda'>
|
|
<qandaentry>
|
|
<question><para>What is the LDP?</para></question>
|
|
<answer><para>The LDP is a loosely knit team of volunteers who provide documentation for many aspects of Linux. There are several forms of documentation: Guides, HOWTOs, man pages and FAQs.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>What is a Guide?</para></question>
|
|
<answer><para>A guide is typically a longer book with broader coverage of a subject; for instance, the Network Administration or User Guide. The intent is to understand the whole subject, as opposed to performing only one task. If you want to have a broader look at some aspect of Linux then the guides should be very handy.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>What is a HOWTO?</para></question>
|
|
<answer><para>HOWTO's are usually step by step guides which describe in detail how to perform a specific task. For example, the Linux Installation
|
|
HOWTO helps you install Linux on the system but it does not cover how to
|
|
set up a web server so that you can focus on a particular task.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>What is a man page?</para></question>
|
|
<answer><para>man (Manual) pages are the standard form of help available for many linux applications and utilities. They can be viewed using the <command>man</command> command. Many of the GNU utilities have a more detailed form of help, called info pages. They can be viewed using the <command>info</command> command.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>What is a FAQ?</para></question>
|
|
<answer><para>A FAQ (Frequently Asked Questions) is a list of questions, usually available in mailing lists to avoid answering repetitive questions
|
|
asked by new users. For example, the Linux FAQ answers questions like, <quote>What is linux?</quote> and, <quote>How is Linux pronounced?</quote></para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>Where do I get all these documents?</para></question>
|
|
<answer><para>Most Linux distributions include the LDP documents, so there is a high chance they are already available for you if you've installed Linux. The latest versions are available at <ulink url="http://www.tldp.org" />.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>How are the documents licensed?</para></question>
|
|
<answer><para>LDP only has documents available under a free license, like the GNU Free Documentation License, which means that you are allowed to distribute, modify and do whatsoever you want to do, as long as you do not change the copyright and licensing terms.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>Are all the topics in the LDP related to Linux?</para></question>
|
|
<answer><para>Not essentially. There are several other applications, langauges and operating systems which are covered at the LDP. The LDP accepts the document if it is of any interested to general Linux users. For example, the Linux+Windows HOWTO explains in detail how your Linux system can coexist along with Windows.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>Who contributes to the LDP?</para></question>
|
|
<answer><para>Application developers who usually provide help files along with their programs often submit their documentation to the LDP. Increasingly, new users are solving their Linux issues and documenting their work to help others in the community.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>Why should I contribute?</para></question>
|
|
<answer><para>Authors who want to help others by providing some documentation can do so through the LDP. The documents should be under a free license, such as the GNU free documentation license, which ensures that everyone is benefited through your documents. Here are some of the major benefits when you contribute through the LDP:</para>
|
|
|
|
<itemizedlist>
|
|
<listitem><para>The LDP hosts the document and ensures that it is available in all the formats, including text, html and pdf, so it may be viewed in a platform-independent manner.</para></listitem>
|
|
<listitem><para>The LDP documents are available as part of many distributions and hence your documents reach a wide community of Linux users.</para></listitem>
|
|
<listitem><para>Many of the Linux users who read your document may give you comments, suggestions or even provide additional content which ensures the document is reliable and updated whenever neccessary.</para></listitem>
|
|
<listitem><para>You may be providing some crucial help to users who come across the same issues that you solved on your own.</para></listitem>
|
|
<listitem><para>It is a form of contribution to the Linux and open source community which depends on volunteers for its growth.</para></listitem>
|
|
<listitem><para>You may also publish any of the LDP's documents, including your own, and get monetary benefits from the whole process.</para></listitem>
|
|
</itemizedlist>
|
|
</answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>How do I contribute?</para></question>
|
|
<answer>
|
|
<para>If you know a particular topic well, first search the LDP's
|
|
website (<ulink url="http://www.tldp.org" />) for related documentation. If something is already available, you can contact the author through email, which will probably be available within the document, and coordinate your work
|
|
together. There are also some unmaintained documents that you can take care of.If the topic is an entirely new one, subscribe to the Discussion
|
|
mailing list at <email>discuss@en.tldp.org</email> and and propose the topic to your peers first, to gather feedback. After the feedback and draft are complete, the doc could be submitted, as per the instructions in the Author Guide, advising LDP that these steps were taken. This avoids having someone come back later and tell you that this subject was not acceptable (which is rarely the case). Contact the HOWTO coordinator listed at the LDP's website if you require any expert help. When you follow the above steps you are ensured the following benefits:</para>
|
|
|
|
<itemizedlist>
|
|
<listitem><para>If any other person is interested in contributing you may team up.</para></listitem>
|
|
<listitem><para>The topic you wish to cover may already be available as part of some other documentation that you are not aware of and repetitive work may be avoided.</para></listitem>
|
|
<listitem><para>You may recieve guidance in the form of help, tools and other resources which will speed up your writing.</para></listitem>
|
|
</itemizedlist>
|
|
|
|
<para>Since the LDP is a informal organisation of volunteers you do not need any kind of membership to contribute. Everyone is encouraged to help in
|
|
whatever way they can.</para>
|
|
</answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>In what format do I have to write the documentation?</para></question>
|
|
<answer><para>The source files for LDP documentation are created using SGML or XML markup, usually with either DocBook XML (v4.2 or v4.1.2) or SGML (v4.2, v4.1, and v3.x). There is an older but acceptable standard called Linuxdoc SGML, which is not as robust. If you do not know any of these then you can write in plain text initially and submit the documentation, which can be converted to markup. Future updates would be done in either DocBook or Linuxdoc. SGML and XML markup are easy enough to learn if you are interested in maintaining the documentation over a long period. You may request help from volunteers in the mailing list to convert your documentation into DocBook for the first time, or refer to the Author's Guide for information on using these tools on your system.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>How do I submit documentation?</para></question>
|
|
<answer><para>The LDP Author HOWTO provides all the details you would like to know including links to other resources and tools. Please go to <ulink url="http://www.tldp.org">www.tldp.org</ulink> to have a look. The email address to submit English language documentation is <email>submit@en.tldp.org</email>. For those who want to write in languages other than English, email the discussion list to know what languages are available, and also to solicit the help of volunteers for any translation or review help.</para></answer>
|
|
</qandaentry>
|
|
|
|
<qandaentry>
|
|
<question><para>What if I have question which hasn't been answered here?</para></question>
|
|
<answer><para>
|
|
I might have missed it. Please email discuss@en.tldp.org. If it's answered and you feel it should be included here, then send me a copy and I will add it to the next revision of this document.</para></answer>
|
|
</qandaentry>
|
|
|
|
</qandaset>
|
|
</article>
|
|
|