LDP
/
LDP
mirror of https://github.com/tLDP/LDP
0
1
Fork 0
Code Releases Activity

Submitting 1.4 with changes from Emma and Tabatha including a new license.

This commit is contained in:
emmajane 2004-05-30 21:25:32 +00:00
parent c60efbd583
commit dfa40516fb
1 changed files with 38 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
LDP/faq/docbook/LDP-FAQ.xml
View File

@ -1,6 +1,7 @@
<?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>
@ -12,8 +13,17 @@
</address>
</affiliation>
</author>
<pubdate>February 2003</pubdate>
<pubdate>2004-05-31</pubdate>
<revhistory>
<revision>
<revnumber>1.4</revnumber>
<date>2004-05-31</date>
<authorinitials>RS</authorinitials>
<revremark>
Added a few more FAQ's and minor modifications from Emma Jane Hogbin and updated to Creative Commons Attribution-Sharealike 2.0 License per TM.
</revremark>
</revision>
<revision>
<revnumber>1.3</revnumber>
<date>2003-11-15</date>
@ -47,16 +57,20 @@ Initial Release, reviewed by LDP
</revremark>
</revision>
</revhistory>
<legalnotice id="legalnotice">
<para> 2003, Rahul Sundaram</para>
<blockquote>
<para>Copyright (c) 2003 by Rahul Sundaram. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at <ulink url="http://www.opencontent.org/openpub/"></ulink>).</para>
<para>Copyright (c) 2003 by Rahul Sundaram. This material is licensed under the Creative Commons Attribution-Sharealike 2.0 License. Terms and conditions for distribution can be found at <ulink url="http://creativecommons.org/licenses/by-sa/2.0/">Creative Commons</ulink>).</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>
@ -119,7 +133,7 @@ Initial Release, reviewed by LDP
<para>Are all of the topics that are in the LDP related to Linux?</para>
</question>
<answer>
<para>Not essentially. There are several other applications, languages, and operating systems that are covered at the LDP. LDP accepts the document if it is of any interest to general Linux users. For example, the Linux+Windows HOWTO explains, in detail, how your Linux system can coexist with Windows.</para>
<para>Yes. There are several other applications, languages, and operating systems that are covered at the LDP. LDP accepts the document if it is of any interest to general Linux users. For example, the Linux+Windows HOWTO explains, in detail, how your Linux system can coexist with Windows. Documents that do not relate directly to Linux won't be accepted.</para>
</answer>
</qandaentry>
<qandaentry>
@ -183,15 +197,31 @@ Initial Release, reviewed by LDP
<para>In which format should I write the documentation?</para>
</question>
<answer>
<para>The source files for LDP documentation are created by 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 programs, then you can write in plain text and submit the documentation, which will 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 of time. You may request help from volunteers in the mailing list to convert your documentation into DocBook for the first time, or refer to the LDP Author Guide for information about using these tools on your system.</para>
<para>In any format you would like! Documents will be maintained in DocBook XML or LinuxDoc and will be converted for you by a volunteer. You may choose to use an editing suite (like OpenOffice.org) to write the DocBook for you. There are also scripts available to convert LyX and ASCII documents to DocBook.</para>
</answer>
</qandaentry>
<qandaentry>
<qandaentry>
<question>
<para> DocBook is too hard to learn for a LyX user like me. Why do you use it?</para>
</question>
<answer>
<para>It's not just LyX users that say this, but here's the answer... There are hundreds of documents in our collection. We have one set of scripts to convert each of these documents into human-readable formats (HTML, PostScript and PDF). We use these scripts not only to save time, but also to keep our collection visually similar, as requested by many of our readers (read <ulink url="http://ask.slashdot.org/article.pl?sid=04/03/30/0041253" /> for more information. DocBook is a very descriptive markup language specifically desgined to describe technical documentation. Always under active development, DocBook is be used to output a variety of formats, including HTML pages, slide shows, PDF and PostScript for printed materials. We are always interested in hearing about scripts or tools for converting text to DocBook. Please read the <ulink url="http://tldp.org/LDP/LDP-Author-Guide/html/x2docbook.html">Author Guide</ulink> and contribute your ideas to the <quote>Discuss</quote> mailing list. LyX users should also read <ulink url="http://www.teledyn.com/help/XML/lyx2db/t1.html" /> for more information.</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>How should I submit documentation?</para>
</question>
<answer>
<para>The LDP Author HOWTO provides all of the details that 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 e-mail address to submit English-language documentation is <email>submit@en.tldp.org</email>. If you want to write in languages other than English, e-mail the discussion list to know what languages are available, and also to solicit the help of volunteers for any translation or review help.</para>
<para>For your convenience, this process is summarized in our <ulink url="http://www.tldp.org/LDP/LDP-Author-Guide/html/process.html">Author Guide</ulink>.</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para> Will my document be reviewed before it is accepted to the collection?</para>
</question>
<answer>
<para> All new documents are reviewed according to the <ulink url="http://tldp.org/HOWTO/LDP-Reviewer-HOWTO/">LDP Reviewer HOWTO</ulink>. Each document will go through three reviews: technical, language and meta-data. You can read about these reviews in the LDP Reviewer HOWTO.</para>
</answer>
</qandaentry>
<qandaentry>
@ -199,9 +229,10 @@ Initial Release, reviewed by LDP
<para>What if I have question that hasn't been answered here?</para>
</question>
<answer>
<para>If you feel that a question isn't answered in this FAQ, please send e-mail to the Discussion list <email>discuss@en.tldp.org</email>. If someone on the Discussion list answers the question and you feel that it should be included here, send me a copy of both the question that you asked and the answer that you received to the author of this document. The author's e-mail address is listed at the top of this page.</para>
<para>If your question hasn't been answered in this FAQ, please send e-mail to the Discussion list (<email>discuss@en.tldp.org</email>) after subscribing to it. More information is also available at <ulink url="http://www.tldp.org/mailinfo.html" />. If someone on the Discussion list answers the question and you feel that it should be included here, send a copy of both the question that you asked and the answer that you received to the author of this document. The author's e-mail address is listed at the top of this page.</para>
</answer>
</qandaentry>
</qandaset>
</article>