Revision: fe77580e51b2
Author: Janne Härkönen <[email protected]>
Date: Thu Feb 16 21:50:27 2012
Log: userguide: document preformatted text blocks
Update issue 447
Added initial doc in the user guide
http://code.google.com/p/robotframework/source/detail?r=fe77580e51b2
Modified:
/doc/userguide/src/Appendices/DocumentationFormatting.txt
=======================================
--- /doc/userguide/src/Appendices/DocumentationFormatting.txt Sat Jun 18
16:49:11 2011
+++ /doc/userguide/src/Appendices/DocumentationFormatting.txt Thu Feb 16
21:50:27 2012
@@ -145,6 +145,24 @@
*2* Hi
======== ======== ========
+Preformatted text
+~~~~~~~~~~~~~~~~~
+
+Starting from Robot Framework 2.7, it is also possible to embed blocks of
+preformatted text in the documentation. Preformatted block is created by
+starting lines with '| ', one space being mandatory after the pipe
character.
+The sequence '| ' will be removed from the resulting HTML, but all other
+whitespace is preserved.
+
+In the following documentation, the two middle lines form a preformatted
+block when converted to HTML::
+
+ Doc before block:\n
+ | inside block\n
+ | some additional whitespace\n
+ After block
+
+
Horizontal ruler
~~~~~~~~~~~~~~~~
