From 650a2f9f5807536ee118ba031622bede7f4e1642 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Buclin?= Date: Mon, 24 Oct 2011 12:35:48 +0200 Subject: Bug 423496: Compile the documentation with xmlto + dblatex instead of openjade r=glob a=LpSolit --- docs/en/xml/conventions.xml | 169 ++++++++++++-------------------------------- 1 file changed, 45 insertions(+), 124 deletions(-) (limited to 'docs/en/xml/conventions.xml') diff --git a/docs/en/xml/conventions.xml b/docs/en/xml/conventions.xml index 70e6624f7..6a8f8b47e 100644 --- a/docs/en/xml/conventions.xml +++ b/docs/en/xml/conventions.xml @@ -1,144 +1,65 @@ - + + + %myents; +]> +
Document Conventions - - conventions - - This document uses the following conventions: - - - - - Descriptions - - Appearance - - - - - - Caution - - - - Don't run with scissors! - - - - - - Hint or Tip - - - - For best results... - - - - - - Note - - - - Dear John... - - - - - - Warning - - - - Read this or the cat gets it. - - - - - - File or directory name + + This is a caution. Make sure to read this to not be in trouble! + - - filename - - + + This is a hint or tip, especially about some configuration tweaks. + - - Command to be typed + + This is just a note, for your information. + - - command - - + + This is a warning, something you should take care of. + - - Application name - - - application - - - - - - Normal user's prompt under bash shell - - bash$ - - - - - Root user's prompt under bash shell - - bash# - - - - - Normal user's prompt under tcsh shell - - tcsh$ - - - - Environment variables + + A filename or a path to a filename is displayed like this: + /path/to/filename.ext + - - VARIABLE - - + + A command to type in the shell is displayed like this: + command --arguments + - - Term found in the glossary + bash$ represents a normal user's prompt under bash shell - - Bugzilla - - + bash# represents a root user's prompt under bash shell - - Code example + + A word which is in the glossary will appear like this: + Bugzilla + - - para -Beginning and end of paragraph -para - - - - - + + A sample of code is illustrated like this: + +First Line of Code +Second Line of Code +... + + - - This documentation is maintained in DocBook 4.1.2 XML format. + + This documentation is maintained in DocBook 4.2 XML format. Changes are best submitted as plain text or XML diffs, attached - to a bug filed in the &bzg-bugs; component. + to a bug filed in the Bugzilla Documentation + component. -