[gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/, keywording/, ...
commit: 2df9bf10b39c0ca645c4f273b51f9989af311cb5 Author: Ulrich Müller gentoo org> AuthorDate: Thu Jan 2 12:47:14 2020 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Jan 2 12:47:14 2020 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=2df9bf10 Remove newlines from section titles. These will get embedded into anchors, making them invalid. Signed-off-by: Ulrich Müller gentoo.org> appendices/contributing/devbook-guide/text.xml | 4 +--- general-concepts/dependencies/text.xml | 4 +--- keywording/text.xml| 4 +--- 3 files changed, 3 insertions(+), 9 deletions(-) diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml index 7c59ed4..ce3fab9 100644 --- a/appendices/contributing/devbook-guide/text.xml +++ b/appendices/contributing/devbook-guide/text.xml @@ -270,9 +270,7 @@ exactly, making it well-suited for code excerpts: - - c, b, and e - +c, b, and e diff --git a/general-concepts/dependencies/text.xml b/general-concepts/dependencies/text.xml index 0c0327a..195371c 100644 --- a/general-concepts/dependencies/text.xml +++ b/general-concepts/dependencies/text.xml @@ -419,9 +419,7 @@ DEPEND="!build? ( - -Any of Many Dependencies - +Any of Many Dependencies diff --git a/keywording/text.xml b/keywording/text.xml index a1dbed1..d3c5ea4 100644 --- a/keywording/text.xml +++ b/keywording/text.xml @@ -267,9 +267,7 @@ Vulnerability Treatment Policy - -Simultaneous stabilization on all architectures - +Simultaneous stabilization on all architectures If you maintain an architecture-independent package (data files,
[gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
commit: 491304c07ca6951359d417add04d3a503cb47ed0 Author: Ulrich Müller gentoo org> AuthorDate: Thu Dec 26 19:34:57 2019 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Dec 26 20:40:28 2019 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=491304c0 appendices/contributing/devbook-guide: Update 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 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: dl A Definition List Tag containing dt - Pairs of Definition Term Tags + Definition Term Tags, dd - and Definition Data Tags - - - -The following list copied from http://www.w3.org/TR/REC-html40/struct/lists.html;>w3.org shows -that a definition list can contain ordered and unordered lists. It may not -contain another definition list though. - - - - The ingredients: - - - 100 g. flour - 10 g. sugar - 1 cup water - 2 eggs - salt, pepper - - - The procedure: - - - Mix dry ingredients thoroughly - Pour in wet ingredients - Mix for 10 minutes - Bake for one hour at 300 degrees - - - Notes: - The recipe may be improved by adding raisins + each followed by one or more Definition Data Tags.
[gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
commit: 88fdd7e242a75846bd149c5e6c02d804701d58e6 Author: Ulrich Müller gentoo org> AuthorDate: Thu Dec 26 19:28:37 2019 + Commit: Ulrich Müller gentoo org> CommitDate: Thu Dec 26 20:40:28 2019 + 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 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. + +Definition lists (dl) are also supported. Please note that +neither the definition term tag (dt) nor the definition data tag +(dd) accept any other block level tag such as paragraphs or +admonitions. A definition list comprises: + + + + dl + A Definition List Tag containing + dt + Pairs of Definition Term Tags + dd + and Definition Data Tags + + + +The following list copied from http://www.w3.org/TR/REC-html40/struct/lists.html;>w3.org shows +that a definition list can contain ordered and unordered lists. It may not +contain another definition list though. + + + + The ingredients: + + + 100 g. flour + 10 g. sugar + 1 cup water + 2 eggs + salt, pepper + + + The procedure: + + + Mix dry ingredients thoroughly + Pour in wet ingredients + Mix for 10 minutes + Bake for one hour at 300 degrees + + + Notes: + The recipe may be improved by adding raisins + +
[gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
commit: fd81a6293d0ab6138dfab3bc429b6cac26de375a Author: Ulrich Müller gentoo org> AuthorDate: Wed Dec 4 14:22:56 2019 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Dec 8 11:32:02 2019 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=fd81a629 devbook-guide: Rename and . These tags are called and throughout, and that's also what devbook.xsl expects. Rename them in the devbook guide. Signed-off-by: Ulrich Müller 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 @@ -230,13 +230,13 @@ Make HTML/XML easier to read by using selective emphasis: This is a note. - + This is a warning. - + - + This is important. - + @@ -247,10 +247,10 @@ This is important. We introduced a lot of new tags in the previous section -- here's what you need to know. The p (paragraph), pre (code block), -note, warn (warning) and impo -(important) tags all can contain one or more lines of text. Besides the -table, ul, ol and -dl elements (which we'll cover in just a bit), these are the +note, warning (warning) and +important (important) tags all can contain one or more lines of +text. Besides the table, ul, ol +and dl elements (which we'll cover in just a bit), these are the only tags that should appear immediately inside a body element. Another thing -- these tags should not be stacked -- in other words, don't put a note element inside a p element. As @@ -490,8 +490,8 @@ GuideXML-tag (both opening as closing), except for: body (opening tag only) and before every chapter, p, table, author (set), pre, ul, -ol, warn, note and -impo (opening tags only). +ol, warning, note and +important (opening tags only).
[gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/, ebuild-writing/common-mistakes/
commit: 5fe0b5964f26783b506fdf16d91f2a14aead99cd Author: Ulrich Müller gentoo org> AuthorDate: Wed Dec 4 18:14:55 2019 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Dec 8 11:32:06 2019 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=5fe0b596 Element in or is not supported. Signed-off-by: Ulrich Müller gentoo.org> appendices/contributing/devbook-guide/text.xml | 26 +- ebuild-writing/common-mistakes/text.xml| 2 +- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml index 8b8e1c0..29be787 100644 --- a/appendices/contributing/devbook-guide/text.xml +++ b/appendices/contributing/devbook-guide/text.xml @@ -43,26 +43,26 @@ tags used in a GuideXML document: !DOCTYPE guide SYSTEM "/dtd/guide.dtd" !-- Header -- -guide lang="en" -titleGentoo Documentation Guide/title +guide lang="en" +titleGentoo Documentation Guide/title -author title="Author" - mail link="yourn...@gentoo.org"Your Name/mail +author title="Author" + mail link="yourn...@gentoo.org"Your Name/mail /author abstract -This guide shows you how to compose web documentation using +This guide shows you how to compose web documentation using our new lightweight Gentoo GuideXML syntax. This syntax is the official format for Gentoo web documentation, and this document itself was created -using GuideXML. +using GuideXML. /abstract !-- The content of this document is licensed under the CC-BY-SA license -- !-- See https://creativecommons.org/licenses/by-sa/3.0 -- license version="3.0"/ -version1/version -date2011-11-29/date +version1/version +date2011-11-29/date @@ -139,13 +139,13 @@ guide document: chapter -titleThis is my chapter/title +titleThis is my chapter/title section -titleThis is section one of my chapter/title +titleThis is section one of my chapter/title body p -This is the actual text content of my section. +This is the actual text content of my section. /p /body @@ -222,10 +222,10 @@ Type ls if you feel like it. I really want to go to sleep now. This is text output or code. -# this is user input +# this is user input Make HTML/XML easier to read by using selective emphasis: -foobar/foo +foobar/foo diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml index c196e16..6846ed1 100644 --- a/ebuild-writing/common-mistakes/text.xml +++ b/ebuild-writing/common-mistakes/text.xml @@ -504,7 +504,7 @@ The best way to generate it would be: -$ diff -u some-package-0.1.0.ebuild some-package-0.2.0.ebuild ~/some-package-0.2.0.diff +$ diff -u some-package-0.1.0.ebuild some-package-0.2.0.ebuild ~/some-package-0.2.0.diff
[gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
commit: 6a1c35efce4347c22c94680e39a84d3f1df794d0 Author: Ulrich Müller gentoo org> AuthorDate: Wed Dec 4 17:25:41 2019 + Commit: Ulrich Müller gentoo org> CommitDate: Sun Dec 8 11:32:05 2019 + URL:https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6a1c35ef devbook-guide: Don't mention caption as attribute of . Signed-off-by: Ulrich Müller 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 cls/c if you feel like it. I ereally/e want to go to sleep now. /p -pre caption="Code Sample" +pre This is text output or code. # ithis is user input/i @@ -257,12 +257,11 @@ only tags that should appear immediately inside a body element. Another thing -- these tags should not be stacked -- in other words, don't put a note element inside a p element. As you might guess, the pre element preserves its whitespace -exactly, making it well-suited for code excerpts. You must name the -pre tag with a caption attribute: +exactly, making it well-suited for code excerpts: -pre caption="Output of uptime" +pre # iuptime/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: -Wrong : pre caption = "Attributes" -Correct: pre caption="Attributes" +Wrong : uri link = "https://forums.gentoo.org/"; +Correct: uri link="https://forums.gentoo.org/"; @@ -580,10 +579,6 @@ with a capital letter. /ul - -Code Listings should always have a caption. - - Try to use uri with the link attribute as much as possible. In other words, the https://forums.gentoo.org;>Gentoo
[gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
commit: 6a17ea975ab6587c6c223db2a7a026dd8812f22e Author: Ulrich Müller gentoo org> AuthorDate: Fri Nov 29 09:28:05 2019 + Commit: Ulrich Müller gentoo org> CommitDate: Fri Nov 29 09:28:05 2019 + 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 gentoo.org> Signed-off-by: Ulrich Müller 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 https://forums.gentoo.org;>Gentoo Forums is preferred over https://forums.gentoo.org. - - - - - -Resources - -Start writing - - - -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 -Documentation Development Tips - Tricks. If you'd like to help (or have any questions about -GuideXML), please post a message to the gentoo-doc mailing list stating what you'd like -to tackle. Have fun! - -
[gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
commit: a39f9d241fb906cc2c7442fe5318f9630dce54df Author: Ulrich Müller gentoo org> AuthorDate: Tue Mar 19 20:25:30 2019 + Commit: Ulrich Müller gentoo org> CommitDate: Tue Mar 19 20:25:30 2019 + 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 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. /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"/ version1/version @@ -111,7 +111,7 @@ required) that these tags appear before the content of the document. Finally we have the license version="3.0"/ tag, used to publish -the document under the http://creativecommons.org/licenses/by-sa/3.0/;>Creative +the document under the https://creativecommons.org/licenses/by-sa/3.0/;>Creative Commons - Attribution / Share Alike license as required by the Documentation Policy. Historically, the tag license / was used, which denoted the 2.5 version of the @@ -183,7 +183,7 @@ an example body element: p This is a paragraph. path/etc/passwd/path is a file. -urihttp://forums.gentoo.org/uri; is my favorite website. +urihttps://forums.gentoo.org/uri; is my favorite website. Type cls/c if you feel like it. I ereally/e want to go to sleep now. /p @@ -214,7 +214,7 @@ Now, here's how the body element above is rendered: This is a paragraph. /etc/passwd is a file. -http://forums.gentoo.org is my favorite web site. +https://forums.gentoo.org is my favorite web site. Type ls if you feel like it. I really want to go to sleep now. @@ -322,13 +322,13 @@ Fill this section with the information about the use of The uri 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 -http://forums.gentoo.org/. To create this link, I typed -urihttp://forums.gentoo.org//uri;. The alternate form is +https://forums.gentoo.org/. To create this link, I typed +urihttps://forums.gentoo.org//uri;. The alternate form is when you want to associate a URI with some other text -- for example, http://forums.gentoo.org/;>the Gentoo Forums. To create -this link, I typed uri link="http://forums.gentoo.org/"the +link="https://forums.gentoo.org/;>the Gentoo Forums. To create +this link, I typed uri link="https://forums.gentoo.org/"the Gentoo Forums/uri. You don't need to write -http://www.gentoo.org/ to link to other parts of the Gentoo web site. +https://www.gentoo.org/ to link to other parts of the Gentoo web site. For instance, a link to the documentation main index should be simply uri link="/doc/en/index.xml"documentation main index/uri. You can even omit index.xml when you link to a @@ -337,9 +337,9 @@ index/uri. Leaving the trailing slash saves an extra HTTP request. -Please avoid the http://en.wikipedia.org/wiki/Click_here;>click here +Please avoid the https://en.wikipedia.org/wiki/Click_here;>click here syndrome as recommended by the http://www.w3.org/QA/Tips/noClickHere;>W3C. +link="https://www.w3.org/QA/Tips/noClickHere;>W3C. @@ -584,8 +584,8 @@ Code Listings should always have a caption. Try to use uri with the link attribute as much as -possible. In other words, the http://forums.gentoo.org;>Gentoo -Forums is preferred over http://forums.gentoo.org. +possible. In other words, the https://forums.gentoo.org;>Gentoo +Forums is preferred over https://forums.gentoo.org.
