mirror of https://github.com/tLDP/LDP
Merge branch 'master' of https://github.com/tLDP/LDP
This commit is contained in:
Martin A. Brown
commit
ed8fec7783
|
|
@ -100,7 +100,7 @@
|
|||
url="http://www.gnu.org/copyleft/fdl.html">GNU Free Documentation
|
||||
License (GFDL)</ulink>, one of the <ulink
|
||||
url="http://www.creativecommons.org/license">Creative Commons
|
||||
Licenses</ulink> (such as <ulink url="http://creativecommons.org/licenses/by-sa/4.0/">Attribution-Share-Alike</ulink>), or the LDP license (currently under review). The full text of the license must be included in your document, including the title and version of the license you are using. The LDP will not accept new documents that do not meet licensing requirements.</para>
|
||||
Licenses</ulink> (such as <ulink url="https://creativecommons.org/licenses/by-nc-sa/4.0/">Attribution-NonCommercial-ShareAlike</ulink> and <ulink url="http://creativecommons.org/licenses/by-sa/4.0/">Attribution-ShareAlike</ulink>), or the LDP license (currently under review). The full text of the license must be included in your document, including the title and version of the license you are using. The LDP will not accept new documents that do not meet licensing requirements.</para>
|
||||
|
||||
<warning>
|
||||
<title>Debian-compatible licenses</title>
|
||||
|
|
|
|||
|
|
@ -44,9 +44,9 @@
|
|||
|
||||
<section id="fix-own">
|
||||
<title>Fixing Your Own Documents</title>
|
||||
<para>If you find an error in your own document, please fix it and re-submit the document. You can re-submit your files by emailing them to <email>submit@en.tldp.org</email>. </para>
|
||||
<para>If you find an error in your own document, please fix it and re-submit the document. If you do not have GitHub access, you can send an e-mail to <email>discuss@en.tldp.org</email> with notification that you have changes and a volunteer will work with you to handle the change. </para>
|
||||
|
||||
<para>If you have been using the CVS, you can submit your changes to the CVS tree and then send a note to the submit mailing list (<email>submit@en.tldp.org</email>). In your email please give the exact path of your document in the CVS tree.</para>
|
||||
<para>If you are using GitHub, you can commit your changes to your local repository and then generate a pull request to have it added to the central repository.</para>
|
||||
|
||||
<para>Remember to update the revision history at the top of the document.</para>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -12,14 +12,14 @@
|
|||
|
||||
<para>
|
||||
As part of the review process a Review Coordinator will add your
|
||||
document to the CVS (including any associated image files) and
|
||||
document to the git repository (including any associated image files) and
|
||||
notify the submit mailing list that your document is ready for
|
||||
publication.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Subsequent updates to your document can be made via the CVS. Please read
|
||||
<xref linkend="cvs" /> for more information.
|
||||
Subsequent updates to your document can be made via git if you like. Please read
|
||||
<xref linkend="git" /> for more information.
|
||||
</para>
|
||||
<!--
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
|
||||
<para>This document uses the following conventions<footnote>
|
||||
<para>Please, take a look at the <ulink
|
||||
url="http://cvsview.tldp.org/index.cgi/LDP/guide/docbook/LDP-Author-Guide/">
|
||||
url="https://raw.githubusercontent.com/tLDP/LDP/master/LDP/guide/docbook/LDP-Author-Guide/LDP-Author-Guide.xml">
|
||||
source</ulink> to see how to get
|
||||
similar results on your documents. You should also remember that
|
||||
the way this appears to you depends on the format in which you are reading
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@
|
|||
The GFDL (GNU Free Documentation License) is available in XML format
|
||||
at <ulink url="http://www.gnu.org/licenses/fdl.xml">http://www.gnu.org/licenses/fdl.xml</ulink>. For a version in appendix format suitable for including
|
||||
in your document, you can see get the XML for this document
|
||||
from CVS at <ulink url="http://cvsview.tldp.org/index.cgi/LDP/guide/docbook/LDP-Author-Guide/fdl-appendix.xml">http://cvsview.tldp.org/index.cgi/LDP/guide/docbook/LDP-Author-Guide/fdl-appendix.xml</ulink>.
|
||||
from GitHub at <ulink url="https://raw.githubusercontent.com/tLDP/LDP/master/LDP/guide/docbook/LDP-Author-Guide/fdl-appendix.xml">https://raw.githubusercontent.com/tLDP/LDP/master/LDP/guide/docbook/LDP-Author-Guide/fdl-appendix.xml</ulink>.
|
||||
</para>
|
||||
<para>
|
||||
TLDP template files for DocBook (XML and SGML) and Linuxdoc SGML are
|
||||
|
|
|
|||
|
|
@ -23,84 +23,6 @@
|
|||
|
||||
&configure-emacs;
|
||||
|
||||
<section id="tools-epcEdit">
|
||||
<title>epcEdit</title>
|
||||
<indexterm><primary>epcEdit</primary></indexterm>
|
||||
<indexterm>
|
||||
<primary>Editors</primary>
|
||||
<secondary>epcEdit</secondary>
|
||||
</indexterm>
|
||||
<para>
|
||||
<ulink url="http://www.tksgml.de/">
|
||||
http://www.tksgml.de</ulink>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The <application>epcEdit</application> program allows you to edit XML files.
|
||||
It has the advantages of not needing to know <application>Emacs</application> or
|
||||
<application>vi</application> before starting, and is cross-platform, working in both
|
||||
Windows and Linux. This is a commercial application, and
|
||||
pricing can be found at
|
||||
<ulink url="http://www.tksgml.de/pricing.html">
|
||||
http://www.tksgml.de/pricing.html</ulink>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Along with visual editing, epcEdit will also validate
|
||||
documents on loading, and on demand by using the <menuchoice
|
||||
moreinfo="none"><guimenu
|
||||
moreinfo="none">Document</guimenu><guimenuitem
|
||||
moreinfo="none">Validate</guimenuitem></menuchoice>
|
||||
command.</para>
|
||||
|
||||
<!-- replace this figure with one that shows an XML file -->
|
||||
<!-- FIXME -->
|
||||
<figure>
|
||||
<title>epcEdit screen shot</title>
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata format="EPS" fileref="sgeditscreenshot.eps"/>
|
||||
</imageobject>
|
||||
<imageobject>
|
||||
<imagedata format="JPG" fileref="sgeditscreenshot.jpg"/>
|
||||
</imageobject>
|
||||
<textobject>
|
||||
<phrase>The screen shot of the <application>epcEdit</application>
|
||||
program shows a
|
||||
tree on the left side that has the document in a
|
||||
hierarchy, while the right side shows the document.
|
||||
Tags are shown with a gray background.</phrase>
|
||||
</textobject>
|
||||
</mediaobject>
|
||||
</figure>
|
||||
</section>
|
||||
|
||||
<section id="tools-morphoneditor">
|
||||
<title>Morphon XML editor</title>
|
||||
<para>
|
||||
<ulink url="http://www.morphon.com/xmleditor/index.shtml">
|
||||
http://www.morphon.com/xmleditor/index.shtml</ulink>
|
||||
</para>
|
||||
<para>
|
||||
This is a commercial application which is currently
|
||||
available for free (with an optional user registration).
|
||||
It is written in Java, allowing it to run on any platform
|
||||
that has a Java Virtual Machine (that is, works in both
|
||||
Windows and Linux).
|
||||
</para>
|
||||
<para>
|
||||
On the plus sides of <application>XMLEditor</application> is the left side of the
|
||||
screen shows the hierarchy of the document (starting with Book
|
||||
and so on). Selecting an item in the list brings you to that
|
||||
part of the document so you can edit it. The right part of the
|
||||
screen shows the text without any markup or tags being shown.
|
||||
If you have external files as ELEMENTS (as the LDP Author Guide
|
||||
does), <application>XMLEditor</application> will follow the links and load the files, so
|
||||
you always work on the entire work. On the minus side of this,
|
||||
you will get errors if a file is missing.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="tools-nedit">
|
||||
<title>nedit</title>
|
||||
<indexterm><primary>nedit</primary></indexterm>
|
||||
|
|
@ -109,16 +31,16 @@
|
|||
<secondary>nedit</secondary>
|
||||
</indexterm>
|
||||
<para>
|
||||
<ulink url="http://nedit.org">
|
||||
http://nedit.org</ulink>
|
||||
<ulink url="http://sourceforge.net/projects/nedit/">
|
||||
http://sourceforge.net/projects/nedit/</ulink>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To be fair, <application>nedit</application> is more
|
||||
for programmers, so it might seem a bit of overkill for new
|
||||
users and especially non-programmers. All that aside, it's
|
||||
extremely powerful, allowing for syntax highlighting. Unlike
|
||||
<application>epcEdit</application>, <application>nedit</application> doesn't allow you to automatically insert tags
|
||||
extremely powerful, allowing for syntax highlighting.
|
||||
<application>nedit</application> doesn't allow you to automatically insert tags
|
||||
or automatically validate your code. However, it does allow
|
||||
for shell commands to be run against the contents of the
|
||||
window (as opposed to saving the file, then checking).
|
||||
|
|
|
|||
|
|
@ -6,8 +6,9 @@
|
|||
|
||||
<para>
|
||||
The LDP uses a number of scripts to distribute your document.
|
||||
These scripts submit your document to the LDP's CVS (a free
|
||||
document version management system), and then they transform your document to other formats that
|
||||
These scripts retrieve your document from the LDP's document
|
||||
version management system (currently git using GitHub), and
|
||||
then they transform your document to other formats that
|
||||
users then read. Your document will also be mirrored on a number
|
||||
of sites worldwide (yet another set of scripts).
|
||||
</para>
|
||||
|
|
|
|||
Loading…
Reference in New Issue