* [gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
@ 2019-03-19 20:25 Ulrich Müller
0 siblings, 0 replies; 6+ messages in thread
From: Ulrich Müller @ 2019-03-19 20:25 UTC (permalink / raw
To: gentoo-commits
commit: a39f9d241fb906cc2c7442fe5318f9630dce54df
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Tue Mar 19 20:25:30 2019 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Tue Mar 19 20:25:30 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=a39f9d24
appendices/contributing/devbook-guide: Update all links to https.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/contributing/devbook-guide/text.xml | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 564e29d..4563e46 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -58,7 +58,7 @@ using GuideXML.</i>
</abstract>
<!-- The content of this document is licensed under the CC-BY-SA license -->
-<!-- See http://creativecommons.org/licenses/by-sa/3.0 -->
+<!-- See https://creativecommons.org/licenses/by-sa/3.0 -->
<license version="3.0"/>
<version><i>1</i></version>
@@ -111,7 +111,7 @@ required) that these tags appear before the content of the document.
<p>
Finally we have the <c><license version="3.0"/></c> tag, used to publish
-the document under the <uri link="http://creativecommons.org/licenses/by-sa/3.0/">Creative
+the document under the <uri link="https://creativecommons.org/licenses/by-sa/3.0/">Creative
Commons - Attribution / Share Alike</uri> license as required by the <uri
link="/proj/en/gdp/doc/doc-policy.xml">Documentation Policy</uri>. Historically,
the tag <c><license /></c> was used, which denoted the 2.5 version of the
@@ -183,7 +183,7 @@ an example <c><body></c> element:
<codesample lang="sgml"><!-- Example of a body element -->
<p>
This is a paragraph. <path>/etc/passwd</path> is a file.
-<uri>http://forums.gentoo.org</uri> is my favorite website.
+<uri>https://forums.gentoo.org</uri> is my favorite website.
Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
</p>
@@ -214,7 +214,7 @@ Now, here's how the <c><body></c> element above is rendered:
<p>
This is a paragraph. <path>/etc/passwd</path> is a file.
-<uri>http://forums.gentoo.org</uri> is my favorite web site.
+<uri>https://forums.gentoo.org</uri> is my favorite web site.
Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
</p>
@@ -322,13 +322,13 @@ Fill this section with the information about the use of
The <c><uri></c> tag is used to point to files/locations on the Internet.
It has two forms -- the first can be used when you want to have the actual URI
displayed in the body text, such as this link to
-<uri>http://forums.gentoo.org/</uri>. To create this link, I typed
-<c><uri>http://forums.gentoo.org/</uri></c>. The alternate form is
+<uri>https://forums.gentoo.org/</uri>. To create this link, I typed
+<c><uri>https://forums.gentoo.org/</uri></c>. The alternate form is
when you want to associate a URI with some other text -- for example, <uri
-link="http://forums.gentoo.org/">the Gentoo Forums</uri>. To create
-<e>this</e> link, I typed <c><uri link="http://forums.gentoo.org/">the
+link="https://forums.gentoo.org/">the Gentoo Forums</uri>. To create
+<e>this</e> link, I typed <c><uri link="https://forums.gentoo.org/">the
Gentoo Forums</uri></c>. You don't need to write
-<c>http://www.gentoo.org/</c> to link to other parts of the Gentoo web site.
+<c>https://www.gentoo.org/</c> to link to other parts of the Gentoo web site.
For instance, a link to the <uri link="/doc/en/">documentation main index</uri>
should be simply <c><uri link="/doc/en/index.xml">documentation main
index</uri></c>. You can even omit <c>index.xml</c> when you link to a
@@ -337,9 +337,9 @@ index</uri></c>. Leaving the trailing slash saves an extra HTTP request.
</p>
<p>
-Please avoid the <uri link="http://en.wikipedia.org/wiki/Click_here">click here
+Please avoid the <uri link="https://en.wikipedia.org/wiki/Click_here">click here
syndrome</uri> as recommended by the <uri
-link="http://www.w3.org/QA/Tips/noClickHere">W3C</uri>.
+link="https://www.w3.org/QA/Tips/noClickHere">W3C</uri>.
</p>
</body>
@@ -584,8 +584,8 @@ Code Listings should <e>always</e> have a <c>caption</c>.
<p>
Try to use <c><uri></c> with the <c>link</c> attribute as much as
-possible. In other words, the <uri link="http://forums.gentoo.org">Gentoo
-Forums</uri> is preferred over <uri>http://forums.gentoo.org</uri>.
+possible. In other words, the <uri link="https://forums.gentoo.org">Gentoo
+Forums</uri> is preferred over <uri>https://forums.gentoo.org</uri>.
</p>
</body>
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
@ 2019-11-29 9:28 Ulrich Müller
0 siblings, 0 replies; 6+ messages in thread
From: Ulrich Müller @ 2019-11-29 9:28 UTC (permalink / raw
To: gentoo-commits
commit: 6a17ea975ab6587c6c223db2a7a026dd8812f22e
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Fri Nov 29 09:28:05 2019 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Nov 29 09:28:05 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6a17ea97
appendices/contributing/devbook-guide: Drop "Resources" section.
This contains only outdated information and broken links to the former
GDP project.
Acked-by: Göktürk Yüksek <gokturk <AT> gentoo.org>
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/contributing/devbook-guide/text.xml | 22 ----------------------
1 file changed, 22 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 4563e46..ec4eb28 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -588,28 +588,6 @@ possible. In other words, the <uri link="https://forums.gentoo.org">Gentoo
Forums</uri> is preferred over <uri>https://forums.gentoo.org</uri>.
</p>
-</body>
-</subsection>
-</section>
-
-<section>
-<title>Resources</title>
-<subsection>
-<title>Start writing</title>
-<body>
-
-<p>
-GuideXML has been specially designed to be "lean and mean" so that developers
-can spend more time writing documentation and less time learning the actual XML
-syntax. Hopefully, this will allow developers who aren't unusually "doc-savvy"
-to start writing quality Gentoo documentation. You might be interested in our
-<uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Documentation Development Tips
-& Tricks</uri>. If you'd like to help (or have any questions about
-GuideXML), please post a message to the <uri
-link="/main/en/lists.xml">gentoo-doc mailing list</uri> stating what you'd like
-to tackle. Have fun!
-</p>
-
</body>
</subsection>
</section>
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
@ 2019-12-09 21:39 Ulrich Müller
0 siblings, 0 replies; 6+ messages in thread
From: Ulrich Müller @ 2019-12-09 21:39 UTC (permalink / raw
To: gentoo-commits
commit: fd81a6293d0ab6138dfab3bc429b6cac26de375a
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Dec 4 14:22:56 2019 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Dec 8 11:32:02 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fd81a629
devbook-guide: Rename <impo> and <warn>.
These tags are called <important> and <warning> throughout, and that's
also what devbook.xsl expects. Rename them in the devbook guide.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/contributing/devbook-guide/text.xml | 28 +++++++++++++-------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index ec4eb28..d1225d6 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -199,13 +199,13 @@ Make HTML/XML easier to read by using selective emphasis:
This is a note.
</note>
-<warn>
+<warning>
This is a warning.
-</warn>
+</warning>
-<impo>
+<important>
This is important.
-</impo>
+</important>
</codesample>
<p>
@@ -230,13 +230,13 @@ Make HTML/XML easier to read by using selective emphasis:
This is a note.
</note>
-<warn>
+<warning>
This is a warning.
-</warn>
+</warning>
-<impo>
+<important>
This is important.
-</impo>
+</important>
</body>
</subsection>
@@ -247,10 +247,10 @@ This is important.
<p>
We introduced a lot of new tags in the previous section -- here's what you need
to know. The <c><p></c> (paragraph), <c><pre></c> (code block),
-<c><note></c>, <c><warn></c> (warning) and <c><impo></c>
-(important) tags all can contain one or more lines of text. Besides the
-<c><table></c>, <c><ul></c>, <c><ol></c> and
-<c><dl></c> elements (which we'll cover in just a bit), these are the
+<c><note></c>, <c><warning></c> (warning) and
+<c><important></c> (important) tags all can contain one or more lines of
+text. Besides the <c><table></c>, <c><ul></c>, <c><ol></c>
+and <c><dl></c> elements (which we'll cover in just a bit), these are the
only tags that should appear immediately inside a <c><body></c> element.
Another thing -- these tags <e>should not</e> be stacked -- in other words,
don't put a <c><note></c> element inside a <c><p></c> element. As
@@ -490,8 +490,8 @@ GuideXML-tag (both opening as closing), except for:
<c><body></c> (opening tag only) and before <e>every</e>
<c><chapter></c>, <c><p></c>, <c><table></c>,
<c><author></c> (set), <c><pre></c>, <c><ul></c>,
-<c><ol></c>, <c><warn></c>, <c><note></c> and
-<c><impo></c> (opening tags only).
+<c><ol></c>, <c><warning></c>, <c><note></c> and
+<c><important></c> (opening tags only).
</p>
<p>
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
@ 2019-12-09 21:39 Ulrich Müller
0 siblings, 0 replies; 6+ messages in thread
From: Ulrich Müller @ 2019-12-09 21:39 UTC (permalink / raw
To: gentoo-commits
commit: 6a1c35efce4347c22c94680e39a84d3f1df794d0
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Dec 4 17:25:41 2019 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Dec 8 11:32:05 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6a1c35ef
devbook-guide: Don't mention caption as attribute of <pre>.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/contributing/devbook-guide/text.xml | 15 +++++----------
1 file changed, 5 insertions(+), 10 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 5aa5525..672a083 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -189,7 +189,7 @@ This is a paragraph. <path>/etc/passwd</path> is a file.
Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
</p>
-<pre caption="Code Sample">
+<pre>
This is text output or code.
# <i>this is user input</i>
@@ -257,12 +257,11 @@ only tags that should appear immediately inside a <c><body></c> element.
Another thing -- these tags <e>should not</e> be stacked -- in other words,
don't put a <c><note></c> element inside a <c><p></c> element. As
you might guess, the <c><pre></c> element preserves its whitespace
-exactly, making it well-suited for code excerpts. You must name the
-<c><pre></c> tag with a <c>caption</c> attribute:
+exactly, making it well-suited for code excerpts:
</p>
<codesample lang="sgml"><!-- Named <pre> -->
-<pre caption="Output of uptime">
+<pre>
# <i>uptime</i>
16:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25
</pre>
@@ -551,8 +550,8 @@ and the attribute value. As an example:
</p>
<codesample lang="sgml"><!-- Attributes -->
-Wrong : <pre caption = "Attributes">
-Correct: <pre caption="Attributes">
+Wrong : <uri link = "https://forums.gentoo.org/">
+Correct: <uri link="https://forums.gentoo.org/">
</codesample>
</body>
@@ -580,10 +579,6 @@ with a capital letter.
</ul>
</codesample>
-<p>
-Code Listings should <e>always</e> have a <c>caption</c>.
-</p>
-
<p>
Try to use <c><uri></c> with the <c>link</c> attribute as much as
possible. In other words, the <uri link="https://forums.gentoo.org">Gentoo
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
@ 2019-12-26 21:36 Ulrich Müller
0 siblings, 0 replies; 6+ messages in thread
From: Ulrich Müller @ 2019-12-26 21:36 UTC (permalink / raw
To: gentoo-commits
commit: 88fdd7e242a75846bd149c5e6c02d804701d58e6
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Dec 26 19:28:37 2019 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Dec 26 20:40:28 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=88fdd7e2
Revert "appendices/contributing/devbook-guide: remove information on definition lists"
This reverts commit a1cad38db2fa2096b1161bf5a6ec85048d5a3a74.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/contributing/devbook-guide/text.xml | 47 ++++++++++++++++++++++++++
1 file changed, 47 insertions(+)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index d39e794..5af7226 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -430,6 +430,53 @@ that you can have lists inside lists. Don't forget that you are writing XML and
that you must close all tags including list items unlike in HTML.
</p>
+<p>
+Definition lists (<c><dl></c>) are also supported. Please note that
+neither the definition term tag (<c><dt></c>) nor the definition data tag
+(<c><dd></c>) accept any other block level tag such as paragraphs or
+admonitions. A definition list comprises:
+</p>
+
+<dl>
+ <dt><c><dl></c></dt>
+ <dd>A <b>D</b>efinition <b>L</b>ist Tag containing</dd>
+ <dt><c><dt></c></dt>
+ <dd>Pairs of <b>D</b>efinition <b>T</b>erm Tags</dd>
+ <dt><c><dd></c></dt>
+ <dd>and <b>D</b>efinition <b>D</b>ata Tags</dd>
+</dl>
+
+<p>
+The following list copied from <uri
+link="http://www.w3.org/TR/REC-html40/struct/lists.html">w3.org</uri> shows
+that a definition list can contain ordered and unordered lists. It may not
+contain another definition list though.
+</p>
+
+<dl>
+ <dt><b>The ingredients:</b></dt>
+ <dd>
+ <ul>
+ <li>100 g. flour</li>
+ <li>10 g. sugar</li>
+ <li>1 cup water</li>
+ <li>2 eggs</li>
+ <li>salt, pepper</li>
+ </ul>
+ </dd>
+ <dt><b>The procedure:</b></dt>
+ <dd>
+ <ol>
+ <li>Mix dry ingredients thoroughly</li>
+ <li>Pour in wet ingredients</li>
+ <li>Mix for 10 minutes</li>
+ <li>Bake for one hour at 300 degrees</li>
+ </ol>
+ </dd>
+ <dt><b>Notes:</b></dt>
+ <dd>The recipe may be improved by adding raisins</dd>
+</dl>
+
</body>
</subsection>
<subsection>
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
@ 2019-12-26 21:36 Ulrich Müller
0 siblings, 0 replies; 6+ messages in thread
From: Ulrich Müller @ 2019-12-26 21:36 UTC (permalink / raw
To: gentoo-commits
commit: 491304c07ca6951359d417add04d3a503cb47ed0
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Thu Dec 26 19:34:57 2019 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Thu Dec 26 20:40:28 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=491304c0
appendices/contributing/devbook-guide: Update <dl> description.
We currently don't allow other lists inside definition lists.
Note that multiple dd following each dt are allowed.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/contributing/devbook-guide/text.xml | 35 ++------------------------
1 file changed, 2 insertions(+), 33 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 5af7226..7c59ed4 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -441,40 +441,9 @@ admonitions. A definition list comprises:
<dt><c><dl></c></dt>
<dd>A <b>D</b>efinition <b>L</b>ist Tag containing</dd>
<dt><c><dt></c></dt>
- <dd>Pairs of <b>D</b>efinition <b>T</b>erm Tags</dd>
+ <dd><b>D</b>efinition <b>T</b>erm Tags,</dd>
<dt><c><dd></c></dt>
- <dd>and <b>D</b>efinition <b>D</b>ata Tags</dd>
-</dl>
-
-<p>
-The following list copied from <uri
-link="http://www.w3.org/TR/REC-html40/struct/lists.html">w3.org</uri> shows
-that a definition list can contain ordered and unordered lists. It may not
-contain another definition list though.
-</p>
-
-<dl>
- <dt><b>The ingredients:</b></dt>
- <dd>
- <ul>
- <li>100 g. flour</li>
- <li>10 g. sugar</li>
- <li>1 cup water</li>
- <li>2 eggs</li>
- <li>salt, pepper</li>
- </ul>
- </dd>
- <dt><b>The procedure:</b></dt>
- <dd>
- <ol>
- <li>Mix dry ingredients thoroughly</li>
- <li>Pour in wet ingredients</li>
- <li>Mix for 10 minutes</li>
- <li>Bake for one hour at 300 degrees</li>
- </ol>
- </dd>
- <dt><b>Notes:</b></dt>
- <dd>The recipe may be improved by adding raisins</dd>
+ <dd>each followed by one or more <b>D</b>efinition <b>D</b>ata Tags.</dd>
</dl>
</body>
^ permalink raw reply related [flat|nested] 6+ messages in thread
end of thread, other threads:[~2019-12-26 21:36 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-11-29 9:28 [gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/ Ulrich Müller
-- strict thread matches above, loose matches on Subject: below --
2019-12-26 21:36 Ulrich Müller
2019-12-26 21:36 Ulrich Müller
2019-12-09 21:39 Ulrich Müller
2019-12-09 21:39 Ulrich Müller
2019-03-19 20:25 Ulrich Müller
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox