File 2760-Add-details-about-CSS-usage-in-the-User-s-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2760-Add-details-about-CSS-usage-in-the-User-s-Guide.patch of Package erlang (Revision a158bff6d0635105e5353db4b3451ab1)

Currently displaying revision a158bff6d0635105e5353db4b3451ab1 , Show latest

From 2c30e9a26f6e7a4561473207d2e0d3cc69d9429f Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Thu, 13 Apr 2017 13:54:43 +0200
Subject: [PATCH] Add details about CSS usage in the User's Guide

---
 lib/common_test/doc/src/run_test_chapter.xml | 44 ++++++++++++++++++----------
 1 file changed, 29 insertions(+), 15 deletions(-)

diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index 76e306c4e..c4552779f 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -1322,8 +1322,8 @@
 	 <title>The Unexpected I/O Log</title>
 	 The test suites overview page includes a link to the Unexpected I/O Log.
 	 In this log, <c>Common Test</c> saves printouts made with
-	 <seealso marker="ct#log-2"><c>ct:log/2</c></seealso> and 
-	 <seealso marker="ct#pal-2"><c>ct:pal/2</c></seealso>, as well as captured system 
+	 <seealso marker="ct#log-2"><c>ct:log/1,2,3,4,5</c></seealso> and 
+	 <seealso marker="ct#pal-2"><c>ct:pal/1,2,3,4,5</c></seealso>, as well as captured system 
 	 error- and progress reports, which cannot be associated with particular test cases and
 	 therefore cannot be written to individual test case log files. This occurs,
 	 for example, if a log printout is made from an external process (not a test 
@@ -1338,7 +1338,7 @@
 	 <title>The Pre- and Post Test I/O Log</title>
 	 The <c>Common Test</c> Framework Log page includes links to the
 	 Pre- and Post Test I/O Log. In this log, <c>Common Test</c> saves printouts made 
-	 with <c>ct:log/2</c> and <c>ct:pal/2</c>, as well as captured system error-
+	 with <c>ct:log/1,2,3,4,5</c> and <c>ct:pal/1,2,3,4,5</c>, as well as captured system error-
 	 and progress reports, which take place before, and after, the test run.
 	 Examples of this are printouts from a CT hook init- or terminate function, or
 	 progress reports generated when an OTP application is started from a CT hook
@@ -1349,8 +1349,8 @@
 	 applications, see section
 	 <seealso marker="ct_hooks_chapter#synchronizing">Synchronizing</seealso>
 	 in section Common Test Hooks.
-	 <note>Logging to file with <c>ct:log/2</c> or <c>ct:pal/2</c>
-	 only works when <c>Common Test</c> is running. Printouts with <c>ct:pal/2</c>
+	 <note>Logging to file with <c>ct:log/1,2,3,4,5</c> or <c>ct:pal/1,2,3,4,5</c>
+	 only works when <c>Common Test</c> is running. Printouts with <c>ct:pal/1,2,3,4,5</c>
 	 are however always displayed on screen.</note>
 	</section>
 
@@ -1371,24 +1371,38 @@
 	<c>Common Test</c> includes an optional feature to allow
 	 user HTML style sheets for customizing printouts. The
 	 functions in <c>ct</c> that print to a test case HTML log
-	 file (<c>log/3</c> and <c>pal/3</c>) accept <c>Category</c>
+	 file (<c>log/3,4,5</c> and <c>pal/3,4,5</c>) accept <c>Category</c>
 	 as first argument. With this argument a category can be specified 
-	 that can be mapped to a selector in a CSS
-	 definition. This is useful, especially for coloring text
+	 that can be mapped to a named <c>div</c> selector in a CSS rule-set.
+	 This is useful, especially for coloring text
 	 differently depending on the type of (or reason for) the
-	 printout. Say you want one color for test system
+	 printout. Say you want one particular background color for test system
 	 configuration information, a different one for test system
 	 state information, and finally one for errors detected by the
 	 test case functions. The corresponding style sheet can
 	 look as follows:
 
 	<pre>
- div.sys_config { background:blue; color:white }
- div.sys_state { background:yellow; color:black }
- div.error { background:red; color:white }</pre>
+ div.sys_config { background:blue }
+ div.sys_state { background:yellow }
+ div.error { background:red }</pre>
+
+ Common Test prints the text from <c>ct:log/3,4,5</c> or
+	<c>ct:pal/3,4,5</c> inside a <c>pre</c> element
+	nested under the named <c>div</c> element. Since the <c>pre</c> selector
+	has a predefined CSS rule (in file <c>ct_default.css</c>) for the attributes
+	<c>color</c>, <c>font-family</c> and <c>font-size</c>, if a user wants to
+	change any of the predefined attribute settings, a new rule for <c>pre</c>
+	must be added to the user stylesheet. Example:
+
+	<pre>
+div.error pre { color:white }</pre>
+
+ Here, white text is used instead of the default black for <c>div.error</c>
+	printouts (and no other attribute settings for <c>pre</c> are affected).
 
 	To install the CSS file (<c>Common Test</c> inlines the definition in the 
-	 HTML code), the name can be provided when executing <c>ct_run</c>.
+	 HTML code), the file name can be provided when executing <c>ct_run</c>.
 	 Example:
 
 	<pre>
@@ -1436,8 +1450,8 @@
 	 suite.
 
 	Argument <c>Category</c> in the previous example can have the
-	 value (atom) <c>sys_config</c> (white on blue), <c>sys_state</c>
-	 (black on yellow), or <c>error</c> (white on red).
+	 value (atom) <c>sys_config</c> (blue background), <c>sys_state</c>
+	 (yellow background), or <c>error</c> (white text on red background).
 </section>
 
 <section>
-- 
2.12.2

Places

File 2760-Add-details-about-CSS-usage-in-the-User-s-Guide.patch of Package erlang (Revision a158bff6d0635105e5353db4b3451ab1)

Places