<c>, , and <e>

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 1E3C21382C5 for ; Fri, 19 Mar 2021 19:23:51 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 6B537E0878; Fri, 19 Mar 2021 19:23:50 +0000 (UTC) Received: from smtp.gentoo.org (smtp.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 4785AE0878 for ; Fri, 19 Mar 2021 19:23:50 +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 7EFFE335D7F for ; Fri, 19 Mar 2021 19:23:48 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 345404A5 for ; Fri, 19 Mar 2021 19:23:47 +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: <1616181579.621fa0991832f3eb80cf0ab26e55a2ba112fc53a.ulm@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/ X-VCS-Repository: proj/devmanual X-VCS-Files: appendices/devbook-guide/text.xml X-VCS-Directories: appendices/devbook-guide/ X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Müller X-VCS-Revision: 621fa0991832f3eb80cf0ab26e55a2ba112fc53a X-VCS-Branch: master Date: Fri, 19 Mar 2021 19:23:47 +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-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 28de17eb-edde-4463-8343-ea27a363f386 X-Archives-Hash: d6f34a9835a7773707459b91f60c245e commit: 621fa0991832f3eb80cf0ab26e55a2ba112fc53a Author: Ulrich Müller gentoo org> AuthorDate: Fri Mar 12 17:41:53 2021 +0000 Commit: Ulrich Müller gentoo org> CommitDate: Fri Mar 19 19:19:39 2021 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=621fa099 devbook-guide: Move all inline elements together Signed-off-by: Ulrich Müller gentoo.org> appendices/devbook-guide/text.xml | 114 +++++++++++++++++++------------------- 1 file changed, 57 insertions(+), 57 deletions(-) diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index bf9e50a..28fbacd 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -247,39 +247,6 @@ preserve their whitespace exactly, making them well-suited for code excerpts: </pre> - - - -<c>, , and <e> - - -

-The <c> element is used to mark up a command or user -input. Think of <c> as a way to alert the reader to something -that they can type in that will perform some kind of action. For example, all -the XML tags displayed in this document are enclosed in a <c> -element because they represent something that the user could type in that is -not a path. By using <c> elements, you'll help your readers -quickly identify commands that they need to type in. Also, because -<c> elements are already offset from regular text, it is rarely -necessary to surround user input with double-quotes. For example, don't -refer to a "<c>" element like I did in this sentence. Avoiding -the use of unnecessary double-quotes makes a document more readable and -adorable! -

- -

-As you might have guessed, is used to boldface some -text. -

- -

-<e> is used to apply emphasis to a word or phrase; for example: -I really should use semicolons more often. As you can see, this text is -offset from the regular paragraph type for emphasis. This helps to give your -prose more punch! -

- @@ -352,30 +319,6 @@ src_install() { } - - - -<uri> - - -

-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 -https://www.gentoo.org/. To create this link, I typed -<uri>https://www.gentoo.org/</uri>. The alternate form is -when you want to associate a URI with some other text for example, -the Gentoo Linux website. To create -this link, I typed <uri link="https://www.gentoo.org/">the -Gentoo Linux website</uri>. -

- -

-Please avoid the click here -syndrome as recommended by the W3C. -

- @@ -509,6 +452,63 @@ together:

The recipe may be improved by adding raisins.

+ + + +<c>, , and <e> + + +

+The <c> element is used to mark up a command or user +input. Think of <c> as a way to alert the reader to something +that they can type in that will perform some kind of action. For example, +all the XML tags displayed in this document are enclosed in a <c> +element because they represent something that the user could type in that is +not a path. By using <c> elements, you'll help your readers +quickly identify commands that they need to type in. Also, because +<c> elements are already offset from regular text, it is rarely +necessary to surround user input with double-quotes. For example, don't +refer to a "<c>" element like I did in this sentence. Avoiding +the use of unnecessary double-quotes makes a document more readable and +adorable! +

+ +

+As you might have guessed, is used to boldface some +text. +

+ +

+<e> is used to apply emphasis to a word or phrase; for example: +I really should use semicolons more often. As you can see, this text is +offset from the regular paragraph type for emphasis. This helps to give your +prose more punch! +

+ + + + +<uri> + + +

+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 +https://www.gentoo.org/. To create this link, I typed +<uri>https://www.gentoo.org/</uri>. The alternate form is +when you want to associate a URI with some other text for example, +the Gentoo Linux website. To create +this link, I typed <uri link="https://www.gentoo.org/">the +Gentoo Linux website</uri>. +

+ +

+Please avoid the click +here syndrome as recommended by the +W3C. +