[Blends-commit] [SCM] blends-gsoc branch, master, updated. f7dddfc57a443aa07331cd8c3716734fbf3451f4
Emmanouil Kiagias
e.kiagias at gmail.com
Thu Sep 26 16:48:56 UTC 2013
The following commit has been merged in the master branch:
commit f7dddfc57a443aa07331cd8c3716734fbf3451f4
Author: Emmanouil Kiagias <e.kiagias at gmail.com>
Date: Thu Sep 26 18:48:49 2013 +0200
fixed all TODOs from the converted documentation, only doc/en/09_todo.xml should be rechecked once more before writing the stylesheet and the Makefile for the documentation
diff --git a/doc/en/00_titletoc.xml b/doc/en/00_titletoc.xml
index 116c174..5690c03 100644
--- a/doc/en/00_titletoc.xml
+++ b/doc/en/00_titletoc.xml
@@ -50,7 +50,7 @@
<para>
You can find the source of this article
<ulink url="http://git.debian.org/?p=blends/blends.git;a=tree;f=doc/en">in the Git repository at git.debian.org</ulink>.
- It is also available as Debian package blends-doc<!-- <package>blends-doc</package>. -->
+ It is also available as Debian package <package>blends-doc</package>.
</para>
<para>
diff --git a/doc/en/02_about.xml b/doc/en/02_about.xml
index a053080..f962dd9 100644
--- a/doc/en/02_about.xml
+++ b/doc/en/02_about.xml
@@ -125,7 +125,7 @@
</para>
<para>
-<!-- <comment>AT: The context is somehow missing here.</comment> -->
+<remark>AT: The context is somehow missing here.</remark>
As you will see later in more detail, Debian Pure Blends are
just a modified ruleset for producing a modified (specialised)
version of Debian GNU/Linux.
diff --git a/doc/en/03_general_ideas.xml b/doc/en/03_general_ideas.xml
index 9538601..2d278b8 100644
--- a/doc/en/03_general_ideas.xml
+++ b/doc/en/03_general_ideas.xml
@@ -182,7 +182,7 @@ for certain software that supports special localisation issues.
they developed might be orphaned; <emphasis>i.e.</emphasis>, not actively
maintained anymore. If their licenses are too restrictive, it may be
impossible for anyone else to take over; sticking to
- <!-- <comment>AT: We should find a way to avoid printing the URL in PDF output.</comment> -->
+ <remark>AT: We should find a way to avoid printing the URL in PDF output.</remark>
<ulink url="http://www.debian.org/social_contract#guidelines">
DFSG</ulink>-free licenses avoids that problem.
</para></listitem><listitem><para>
diff --git a/doc/en/04_existing_blends.xml b/doc/en/04_existing_blends.xml
index 0b48c67..fb1e21e 100644
--- a/doc/en/04_existing_blends.xml
+++ b/doc/en/04_existing_blends.xml
@@ -622,7 +622,7 @@ Motto: "Software that Just Works".
This Blend has many common issues with other Blends. The latest move
of Debian Desktop was to care about more up to date software that can
be used as common base for all Debian Pure Blends. The
-common interest is described in detail in <!-- <xref linkend="new_ways_of_distribution"/> -->. Unfortunately since about 2004 the
+common interest is described in detail in <xref linkend="new_ways_of_distribution"/>. Unfortunately since about 2004 the
project is really silent and it might be considered dead now.
</para>
</sect2>
@@ -791,7 +791,8 @@ Debian GNU/Linux for Enterprise Computing
<varlistentry>
<term>Mathematics</term>
- <listitem><para>There is even already a live CD - see Quantian in <!-- <xref linkend="liveCD"/> --> </para></listitem>
+ <listitem>
+ <para>There is even already a live CD - see Quantian in <xref linkend="liveCD"/></para></listitem>
</varlistentry>
<varlistentry>
diff --git a/doc/en/05_inside.xml b/doc/en/05_inside.xml
index b46e984..03005f9 100644
--- a/doc/en/05_inside.xml
+++ b/doc/en/05_inside.xml
@@ -217,8 +217,8 @@ the community to give back something to Debian. It would be a shame
if somebody would refuse all the advantages to keeping a project
inside Debian, and instead would decide to try to cope with the disadvantages
because he just does not know how to do it the right way, and that it is
-normally easy to propogate changes into Debian. For instance, see
-<!-- <xref linkend="howto_itp"/> -->. This section explains how you can ask for
+normally easy to propogate changes into Debian. For instance, see
+<xref linkend="howto_itp"/>. This section explains how you can ask for
a certain piece of software to be included in Debian.
The next section describes the reason why Debian is flexible enough
to be adapted to any purpose.
diff --git a/doc/en/06_technology.xml b/doc/en/06_technology.xml
index f8f7b98..41f7b65 100644
--- a/doc/en/06_technology.xml
+++ b/doc/en/06_technology.xml
@@ -56,7 +56,7 @@ A metapackage, as used by Blends, is a Debian package that contains:
<para>Configuration stuff (optional)</para>
<itemizedlist>
<listitem><para><orgname>debconf</orgname> questions or pre-seeding</para></listitem>
- <listitem><para><orgname>cfengine</orgname> scripts (or similar see <!-- <xref linkend="EnhancingTechnology"/>-->)</para></listitem>
+ <listitem><para><orgname>cfengine</orgname> scripts (or similar see <xref linkend="EnhancingTechnology"/>)</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Special metapackages:</para>
@@ -499,7 +499,7 @@ so there there will be some usable options in Sarge.
filter feature, which makes it a great tool here.
Moreover <package>synaptic</package> is currently the only user
interface that supports Debian Package Tags
- (see <!-- <xref linkend="debtags"/> --> ).</para>
+ (see <xref linkend="debtags"/> ).</para>
</listitem>
</varlistentry>
@@ -531,7 +531,7 @@ powerful tools for Debian Pure Blends.</emphasis>
<listitem><para>The tasks pages probably provide the best overview about
the actual work which is done in a Debian Pure Blend. These
pages are automatically generated by reading the tasks files
- (see <!-- <xref linkend="debian_control"/> -->) and verifying the existence
+ (see <xref linkend="debian_control"/> ) and verifying the existence
of the packages that are mentioned as dependencies. On the
resulting web page the packages are listed with some meta
information and the description of the package. As user
@@ -616,10 +616,10 @@ powerful tools for Debian Pure Blends.</emphasis>
packages of Debian Med you could point your favourite Browser
to</para>
<para>
-<!-- <comment>FIXME: & is sometimes broken!!!
-<url id="http://packages.debian.org/cgi-bin/search_packages.pl?keywords=med-&subword=1">
+<remark>FIXME: & is sometimes broken!!!
+<ulink url="http://packages.debian.org/cgi-bin/search_packages.pl?keywords=med-&subword=1"/>
^^^^^
-</comment> -->
+</remark>
<ulink url="http://packages.debian.org/cgi-bin/search_packages.pl?keywords=med-&subword=1"/>
</para>
<para>
@@ -834,8 +834,10 @@ The Debian menu system cares for menu updates after each package
installation. To enable compliance with the <emphasis>role</emphasis> based menu
approach it is necessary to rebuild the user menu after each package
installation or after adding new users to the intended role. This can
-be done by using the <!-- <manref name="blend-update-menus" section="8"> -->(see
-<!-- <xref linkend="blend-update-menus"/> -->) script from
+be done by using the
+<citerefentry><refentrytitle>blend-update-menus</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> (see
+<xref linkend="blend-update-menus"/>) script from
<package>blends-common</package>. It has to be said that using
<orgname>blend-update-menus</orgname> is not enough to change the menu of a
user. To accomplish this a call of the general
@@ -922,8 +924,8 @@ package. This was the reason to build a common source package
build metapackages in the style Debian Edu and Debian Med
are currently doing this. The purpose of this package is to
make maintenance of metapackages as easy as possible.</para>
- <para>This package is described in detail in appendix <!-- <xref
- linkend="blends-dev"/>-->.</para>
+ <para>This package is described in detail in appendix <xref
+ linkend="blends-dev"/>.</para>
</listitem>
</varlistentry>
@@ -936,8 +938,8 @@ package. This was the reason to build a common source package
system users in a group named according to the name of the
Blend. The user menu approach is explained in detail
in <xref linkend="userroles"/>.</para>
- <para>This package is described in detail in appendix <!-- <xref
- linkend="blends-common"/> -->.</para>
+ <para>This package is described in detail in appendix <xref
+ linkend="blends-common"/>.</para>
</listitem>
</varlistentry>
@@ -982,7 +984,3 @@ require some tweaks.
</sect1>
</chapter>
-
-<!--
-uncomment xref elements
--->
\ No newline at end of file
diff --git a/doc/en/07_starting.xml b/doc/en/07_starting.xml
index 0c0641f..32c8cac 100644
--- a/doc/en/07_starting.xml
+++ b/doc/en/07_starting.xml
@@ -165,7 +165,7 @@ written by Ben Armstrong <email>synrg at debian.org</email>.
Blends: <ulink url="http://blends.alioth.debian.org"/>. There is a
subdirectory for each Blend and it is very easy to create a simple
index page there which points to the automatically generated web
- pages which are mentioned in <!-- <xref linkend="web_if"/> -->. Following this
+ pages which are mentioned in <xref linkend="web_if"/>. Following this
strategy is quite cheap and has a big effect when using the tools
provided by the Debian Pure Blends effort.
</para>
@@ -276,11 +276,11 @@ written by Ben Armstrong <email>synrg at debian.org</email>.
<para>
The sort of user the project looks after, and which of the needs the
project hopes to address are defined by the project's goals.
- <!-- <comment>BA: I had a bit of trouble deciding how to punctuate the following
+ <remark>BA: I had a bit of trouble deciding how to punctuate the following
passage. I considered and rejected the advice given here in response to
Kirsten's question about punctuating a list of questions:
http://www.udel.edu/eli/g20.html, instead following the advice found
- elsewhere on the Web that double punctuation should be avoided.</comment> -->
+ elsewhere on the Web that double punctuation should be avoided.</remark>
Thus, Debian Jr. first had to decide which children the project
would reach: "What age?" "English speaking children only, or
other languages as well?" Then the project had to determine
@@ -321,14 +321,14 @@ written by Ben Armstrong <email>synrg at debian.org</email>.
<sect2 id="tasksel">
<title>Using tasksel and metapackages</title>
<para>
- According to the plan of the project, the first metapackages (<!--<xref
- linkend="metapackages"/> -->) should be developed. It is not always easy to
+ According to the plan of the project, the first metapackages (<xref
+ linkend="metapackages"/>) should be developed. It is not always easy to
decide what should be included, and which metapackages should be
built. The best way to decide on this point is to discuss on the
mailing list some well thought out proposals.
</para>
<para>
- Section <!-- <xref linkend="text_ui"/> --> mentions <package>tasksel</package> as a tool
+ Section <xref linkend="text_ui"/> mentions <package>tasksel</package> as a tool
to select a Debian Pure Blend, and explains why it is currently not
possible to get a Blend included into the task selection list.
</para>
@@ -411,11 +411,3 @@ written by Ben Armstrong <email>synrg at debian.org</email>.
</sect1>
</chapter>
-
-<!--
-TODO: check again
-line 333 <package>tasksel</package> was <prgn>
-line 85: <emphasis> was <tt>
-line 128 word inside <package> element was wrapped with <var> tag
-uncomment xref values once conversion is finished
--->
\ No newline at end of file
diff --git a/doc/en/08_websentinel.xml b/doc/en/08_websentinel.xml
index 81df61d..dde32db 100644
--- a/doc/en/08_websentinel.xml
+++ b/doc/en/08_websentinel.xml
@@ -349,7 +349,7 @@ RFC822 files and
<para>
The <ulink url="http://ddtp.debian.net/">Debian Description
-Translation Project</ulink> (see <!-- <xref linkend="documentation"/> -->) provides users of
+Translation Project</ulink> (see <xref linkend="documentation"/> ) provides users of
non English languages with information about Debian packages. The
sense of supporting especially the translations of descriptions which
are in the focus of a Blend is to make the Blend even more usable for our
@@ -483,10 +483,3 @@ page reports issues about the packages that are relevant for a Blend.
</sect1>
</chapter>
-
-<!--
-
-line 479: package tag was prgn
-comment out xref elements
-
- -->
\ No newline at end of file
diff --git a/doc/en/09_todo.xml b/doc/en/09_todo.xml
index b8cc11f..eccdbc2 100644
--- a/doc/en/09_todo.xml
+++ b/doc/en/09_todo.xml
@@ -155,7 +155,7 @@ Some Blends maintain their own web space under
information which will be translated by the Debian web team. This is a
good way to inform users about the progress of a project. This page
should link to the apropriate autogenerated pages as described
-in <!-- <xref linkend="web_if"/> --> to make sure that the content of the page remains
+in <xref linkend="web_if"/> to make sure that the content of the page remains
up to date at any time.
</para>
</sect2>
@@ -217,7 +217,7 @@ involved in Debian Package Tags development.
<title>Enhancing basic technologies regarding Debian Pure Blends</title>
<para>
-In section <!-- <xref linkend="future_handling"/> --> several issues where raised how
+In section <xref linkend="future_handling"/> several issues where raised how
handling of metapackages should be enhanced.
</para>
<para>
@@ -496,5 +496,4 @@ done by Debian Edu.
<!--
line 82,90,99-106,234-243 package was prgn
lines 326-390 package elements where tt : need to find a replacement for this element
- uncomment xref elements
-->
diff --git a/doc/en/A_devel.xml b/doc/en/A_devel.xml
index 22abcce..8da6172 100644
--- a/doc/en/A_devel.xml
+++ b/doc/en/A_devel.xml
@@ -318,18 +318,21 @@ the <package>task_diff</package> script (see <xref linkend="statusdump"/>)
<sect2>
<title>Apt <filename>sources.list</filename> files in <filename>/etc/blends/</filename></title>
<para>
-These files are used by <!-- <manref name="blend-gen-control" section="1"> --> to
+These files are used by <citerefentry><refentrytitle>blend-gen-control</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry> to
build valid <filename>debian/control</filename> files that contain only
available packages in their dependencies. This enables building meta
packages for <package>stable</package>, <package>testing</package>, <package>unstable</package> or
even a completely different distribution that has valid
<filename>sources.list</filename> entries. The file
-<filename>/etc/blends/control.list</filename> is used as default for <!-- <manref
-name="blend-gen-control" section="1"> --> and usually is a symbolic link
-(see <!-- <manref name="ln" section="1"> -->) to
+<filename>/etc/blends/control.list</filename> is used as default for
+<citerefentry><refentrytitle>blend-gen-control</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry> and usually is a symbolic link
+(see <citerefentry><refentrytitle>ln</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry>) to
<filename>sources.list.</filename><varname>distribution</varname>. It might be
-changed using the <package>-s </package><varname>dist</varname> option of <!-- <manref
-name="blend-gen-control" section="1"> -->.
+changed using the <package>-s </package><varname>dist</varname> option of <citerefentry><refentrytitle>blend-gen-control</refentrytitle>
+ <manvolnum>1</manvolnum></citerefentry>.
</para>
<para>
<emphasis>TODO:</emphasis> <emphasis>Either parse the available
@@ -363,7 +366,8 @@ behaviour of the tools described below.
</para>
<sect2>
- <title><!-- document type does not allow element "MANREF" here--><package>blend-role(8)</package></title>
+ <title><citerefentry><refentrytitle>blend-role</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry></title>
<para>
<variablelist>
<varlistentry>
@@ -417,8 +421,8 @@ behaviour of the tools described below.
</sect2>
<sect2 id="blend-update-menus">
- <title><!-- document type does not allow element "MANREF"
- here--><package>blend-update-menus(8)</package></title>
+ <title><citerefentry><refentrytitle>blend-update-menus</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry></title>
<para>
<variablelist>
@@ -490,7 +494,8 @@ behaviour of the tools described below.
</sect2>
<sect2>
- <title><!-- document type does not allow element "MANREF" here--><package>blend-user(8)</package></title>
+ <title><citerefentry><refentrytitle>blend-user</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry></title>
<para>
<variablelist>
@@ -553,7 +558,8 @@ behaviour of the tools described below.
</sect2>
<sect2>
- <title><filename>blends.conf(5)</filename></title>
+ <title><citerefentry><refentrytitle>blends.conf</refentrytitle>
+ <manvolnum>5</manvolnum></citerefentry></title>
<para>
<variablelist>
@@ -626,8 +632,11 @@ behaviour of the tools described below.
<varlistentry>
<term>SEE ALSO</term>
<listitem><para>
- <filename>blend-role (8)</filename>, <filename>blend-update-menus (8)</filename>,
- <filename>blend-user (8)</filename></para>
+ <citerefentry><refentrytitle>blend-role</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>blend-update-menus</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>blend-user</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry></para>
</listitem>
</varlistentry>
@@ -826,8 +835,3 @@ the changes by doing:
</para>
</sect1>
</appendix>
-
-<!--
-TODOs
-uncomment and fix the manref elements
- -->
\ No newline at end of file
--
Git repository for blends-gsoc code
More information about the Blends-commit
mailing list