From 6abd5ef1e307cd8c01c3eae60767acc608e7483e Mon Sep 17 00:00:00 2001 From: Timothy Groves Date: Wed, 3 May 2017 11:33:10 +0200 Subject: [PATCH] README update --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.md b/README.md index 5604154..6427b6c 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,51 @@ Modules with `?` are considered _optional_. Modules with `+` are considered _multiple_ (i.e. one or more occurances). Modules with `*` are considered both _optional and multiple_ (i.e. zero, one or more occurances). +### Inner DOM wrappers + +A module might often contain an _inner wrapper_ that in turn contains the contained modules. + +You can document this by adding it to the `dom` setting. + +```yaml +dom: div>div.wrapper +class: ui-block +``` + +defines: + +```markup +
+
+ +
+
+``` + +You can also define the wrapper as its own module, e.g. `WRAPPER`, and then use that: + +```yaml +name: WRAPPER +dom: div +class: ui-wrapper +``` + +```yaml +name: BLOCK +dom: div>WRAPPER +class: ui-block +``` + +defines: + +```markup +
+
+ +
+
+``` + ## The "moduledoc" task ### Overview