From ecc2c5953a5523ab3f4d9709066042c124bf40fc Mon Sep 17 00:00:00 2001 From: Ulrich Müller Date: Sat, 16 Apr 2022 09:16:43 +0200 Subject: devbook-guide: Document the todo element MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ulrich Müller --- appendices/devbook-guide/text.xml | 29 ++++++++++++++++++++--------- 1 file 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>

@@ -212,6 +217,11 @@ This is important. This is a warning. + +Text inside a todo element will appear in the +. + + @@ -224,15 +234,16 @@ This is a warning. We introduced a lot of new tags in the previous section here's what you need to know. The <p> (paragraph), <pre> (preformatted block), <codesample> (code block), -<note>, <important> and <warning> tags -all can contain one or more lines of text. Besides the <figure>, -<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 -you might guess, the <pre> and <codesample> elements -preserve their whitespace exactly, making them well-suited for code excerpts: +<note>, <important>, <warning> and +<todo> tags all can contain one or more lines of text. +Besides the <figure>, <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 you might guess, the <pre> and +<codesample> elements preserve their whitespace exactly, making +them well-suited for code excerpts:

-- cgit v1.2.3-65-gdbad