diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2019-12-04 18:25:41 +0100 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2019-12-08 12:32:05 +0100 |
| commit | 6a1c35efce4347c22c94680e39a84d3f1df794d0 (patch) | |
| tree | 2d415963f847a78b1dc07d8c293c5f9bd58a46c8 /appendices/contributing | |
| parent | Drop caption attribute from <pre> elements. (diff) | |
| download | devmanual-6a1c35efce4347c22c94680e39a84d3f1df794d0.tar.gz devmanual-6a1c35efce4347c22c94680e39a84d3f1df794d0.tar.bz2 devmanual-6a1c35efce4347c22c94680e39a84d3f1df794d0.zip | |
devbook-guide: Don't mention caption as attribute of <pre>.
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'appendices/contributing')
| -rw-r--r-- | appendices/contributing/devbook-guide/text.xml | 15 |
1 files 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> @@ -581,10 +580,6 @@ with a capital letter. </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 Forums</uri> is preferred over <uri>https://forums.gentoo.org</uri>. |