From ce46f75c90f1702a800f111482f045652037c99a Mon Sep 17 00:00:00 2001 From: "Paul W. Frields" Date: Sun, 1 May 2005 19:35:20 +0000 Subject: Extra information about admonition style --- docs-style-en.xml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs-style-en.xml b/docs-style-en.xml index ee7c329..bec145b 100644 --- a/docs-style-en.xml +++ b/docs-style-en.xml @@ -1873,13 +1873,15 @@ Avoid overuse of admonitions. Keep admonitions short and effective by using only the most important material inside the admonition. Move any background material required to explain - the admonition statements outside the admonition. + the admonition statements outside the admonition. Use a short + but descriptive title for an admonition. Use title case for + the admonition title. Incorrect: Lengthy admonition - Using <command>sfdisk</command> + Use <command>sfdisk</command> to check input The sfdisk command accepts a script file as standard input to set up partitions on a hard @@ -1896,18 +1898,18 @@ Correct: Brief admonition - The sfdisk command accepts a script + The sfdisk command accepts a script file as standard input to set up partitions on a hard disk. Sometimes sfdisk will simply reject an erroneous input file. In other cases, it will use the input verbatim, writing an incorrect partition table to your disk. - - Using <command>sfdisk</command> + + Check Input Always use the sfdisk -n command to check your input file before writing to the disk. - + -- cgit