Gentoo GuideXML Guide

From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 961E4138335 for ; Sun, 23 Sep 2018 14:54:33 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id B57F6E070D; Sun, 23 Sep 2018 14:54:31 +0000 (UTC) Received: from smtp.gentoo.org (dev.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 71E28E05C1 for ; Sun, 23 Sep 2018 14:54:31 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id ACFD7335C36 for ; Sun, 23 Sep 2018 14:54:29 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id C6E793DF for ; Sun, 23 Sep 2018 14:54:27 +0000 (UTC) From: "Ulrich Müller" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Ulrich Müller" Message-ID: <1537711668.9f5781ca8f2a0cfeb59194c375704d34a06e451a.ulm@gentoo> Subject: [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/ X-VCS-Repository: proj/devmanual X-VCS-Files: appendices/contributing/devbook-guide/text.xml X-VCS-Directories: appendices/contributing/devbook-guide/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: 9f5781ca8f2a0cfeb59194c375704d34a06e451a X-VCS-Branch: devbook-guide Date: Sun, 23 Sep 2018 14:54:27 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: f53c9591-1a09-4edf-b28e-d19d31b60107 X-Archives-Hash: 0f8e65519b660c59b0c990f54f3dcb70 commit: 9f5781ca8f2a0cfeb59194c375704d34a06e451a Author: Ulrich Müller gentoo org> AuthorDate: Sun Sep 23 14:07:48 2018 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Sun Sep 23 14:07:48 2018 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9f5781ca appendices/contributing/devbook-guide: Move everything into a chapter. Demote previous chapters to sections, and sections to subsections. appendices/contributing/devbook-guide/text.xml | 72 +++++++++++++------------- 1 file changed, 37 insertions(+), 35 deletions(-) diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml index 48fb0ae..23d496a 100644 --- a/appendices/contributing/devbook-guide/text.xml +++ b/appendices/contributing/devbook-guide/text.xml @@ -1,6 +1,7 @@ + Gentoo GuideXML Guide @@ -10,9 +11,9 @@ documentation, and this document itself was created using GuideXML. This guide assumes a basic working knowledge of XML and HTML. - -GuideXML basics

+GuideXML basics + GuideXML design goals @@ -30,12 +31,12 @@ documents.

- - -GuideXML

+GuideXML + Basic structure @@ -125,8 +126,8 @@ license. This is still accepted/allowed.

+ + Chapters and sections @@ -176,8 +177,8 @@ contain at least one <body> element. -

+ + An example <body> @@ -245,8 +246,8 @@ This is important. -

+ + The <body> tags @@ -273,8 +274,8 @@ exactly, making it well-suited for code excerpts. You must name the -

+ + <c>, <b>, and <e> @@ -308,8 +309,8 @@ prose more punch!

+ + Code samples and colour-coding @@ -319,8 +320,8 @@ Fill this section with the information about the use of -

+ + <uri> @@ -349,8 +350,8 @@ link="http://www.w3.org/QA/Tips/noClickHere">W3C.

+ + Figures @@ -365,8 +366,8 @@ for adding images without captions, borders, etc.

+ + Tables @@ -422,8 +423,8 @@ right-aligned, left-aligned or centered with the align attribute. -

+ + Lists @@ -436,8 +437,8 @@ that you must close all tags including list items unlike in HTML.

+ + Intra-document references @@ -454,12 +455,12 @@ to code listing 2 in chapter 2, type

- - -Coding Style

+Coding Style + Introduction @@ -476,8 +477,8 @@ Both sections are described next.

+ + Internal Coding Style @@ -560,8 +561,8 @@ Correct: <pre caption="Attributes"> -

+ + External Coding Style @@ -595,12 +596,12 @@ Forums is preferred over http://forums.gentoo.org.

- - -Resources

+Resources + Start writing @@ -617,6 +618,7 @@ to tackle. Have fun!