From c7911c47c992f5f550607a6786281beaa2d7f5a3 Mon Sep 17 00:00:00 2001 From: Wilson Lin Date: Fri, 10 Aug 2018 21:57:49 +1200 Subject: [PATCH] Clarify CLI option tags list values --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 689c513..a081326 100644 --- a/README.md +++ b/README.md @@ -324,9 +324,10 @@ Tags not in one of the categories below are **specific tags**. Note that only existing whitespace will be up for removal via minification. Entities that represent whitespace will not be decoded and then removed. -For options that have a list of tags as their values, the tags should be separated by a comma. +For options that have a list of tags as their value, the tags should be separated by a comma. -An `*` (asterisk, U+002A) can be used to represent the complete set of possible tags. It essentially fully enables or disables the option. +An `*` (asterisk, U+002A) can be used to represent the complete set of possible tags. Providing no value represents the empty set. +Both values essentially fully enables or disables the option. For brevity, hyperbuild has built-in sets of tags that can be used in place of declaring all their members; they begin with a `$` sign: @@ -343,6 +344,17 @@ For brevity, hyperbuild has built-in sets of tags that can be used in place of d |`$void`|`area`, `base`, `br`, `col`, `embed`, `hr`, `img`, `input`, `keygen`, `link`, `meta`, `param`, `source`, `track`, `wbr`|[voidtags.c](src/main/c/rule/tag/voidtags.c)| |`$wss`|`pre`, `code`|[wsstags.c](src/main/c/rule/tag/wsstags.c)| +As an example, for `--MXcollapseWhitespace`, here are some possible values: + +|Arguments|Description| +|---|---| +|`--MXcollapseWhitespace $wss`|Collapse whitespace in all tags except `$wss` ones| +|`--MXcollapseWhitespace $content,$wss`|Collapse whitespace in all tags except `$content` and `$wss` ones| +|`--MXcollapseWhitespace $content,$wss,dd`|Collapse whitespace in all tags except `$content` and `$wss` ones, as well as the `dd` tag| +|`--MXcollapseWhitespace sup,dd`|Collapse whitespace in all tags except `sup` and `dd`| +|`--MXcollapseWhitespace`|Collapse whitespace in all tags| +|`--MXcollapseWhitespace *`|Don't collapse whitespace in any tag| + #### `--MXcollapseWhitespace $wss` Reduce a sequence of whitespace characters in text nodes to a single space (U+0020), unless they are a child of the tags specified by this option.