diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2022-04-16 09:16:43 +0200 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2023-11-05 17:47:49 +0100 |
| commit | ecc2c5953a5523ab3f4d9709066042c124bf40fc (patch) | |
| tree | 67dbe50ea6a4e244d8c9746a3d2944eb616ae25d | |
| parent | devbook-guide: Don't require blank lines in list items and table cells (diff) | |
| download | devmanual-ecc2c5953a5523ab3f4d9709066042c124bf40fc.tar.gz devmanual-ecc2c5953a5523ab3f4d9709066042c124bf40fc.tar.bz2 devmanual-ecc2c5953a5523ab3f4d9709066042c124bf40fc.zip | |
devbook-guide: Document the todo element
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
| -rw-r--r-- | appendices/devbook-guide/text.xml | 29 |
1 files changed, 20 insertions, 9 deletions
diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 484a230..5015f0b 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -178,6 +178,11 @@ This is important. <warning> This is a warning. </warning> + +<todo> +Text inside a <c>todo</c> element will appear in the +<uri link="::appendices/todo-list/"/>. +</todo> </codesample> <p> @@ -212,6 +217,11 @@ This is important. This is a warning. </warning> +<todo> +Text inside a <c>todo</c> element will appear in the +<uri link="::appendices/todo-list/"/>. +</todo> + </body> </subsection> </section> @@ -224,15 +234,16 @@ This is a warning. We introduced a lot of new tags in the previous section <d/> here's what you need to know. The <c><p></c> (paragraph), <c><pre></c> (preformatted block), <c><codesample></c> (code block), -<c><note></c>, <c><important></c> and <c><warning></c> tags -all can contain one or more lines of text. Besides the <c><figure></c>, -<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 <d/> these tags <e>should not</e> be stacked <d/> 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> and <c><codesample></c> elements -preserve their whitespace exactly, making them well-suited for code excerpts: +<c><note></c>, <c><important></c>, <c><warning></c> and +<c><todo></c> tags all can contain one or more lines of text. +Besides the <c><figure></c>, <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 <d/> these tags <e>should not</e> +be stacked <d/> 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> and +<c><codesample></c> elements preserve their whitespace exactly, making +them well-suited for code excerpts: </p> <codesample lang="sgml"><!-- Named <pre> --> |