From f1a129b6651e963b397e47ce9aaa05d48d6d42b8 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Mon, 12 May 2014 08:32:24 +0530 Subject: [PATCH] Add a note about how the beautify algorithm works. --- manual/edit.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/manual/edit.rst b/manual/edit.rst index fc825782da..54fec8ffda 100644 --- a/manual/edit.rst +++ b/manual/edit.rst @@ -386,6 +386,13 @@ broken HTML/CSS. Therefore, if you dont want any auto-fixing to be performed, first use the Check Book tool to correct all problems and only then run beautify. Accessed via :guilabel:`Tools->Beautify all files`. +.. note:: + In HTML any text can have significant whitespace, via the CSS white-space + directive. Therefor, beautification could potentially change the rendering + of the HTML. To avoid this, as much as possible, the beautify algorithm + only beautifies block level tags that contain other block level tags. So, + for example, text inside a

tag will not have its whitespace changed. + Insert inline Table of Contents ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^