remixml - npm Package Compare versions

Comparing version 1.0.22 to 1.1.0

package.json

 {
   "name": "remixml",
-  "version": "1.0.22",
+  "version": "1.1.0",
   "description": "XML/HTML-like macro language/template engine",
@@ -5,0 +5,0 @@ "main": "remixml.js",

README.md

@@ -54,27 +54,24 @@ <h1>Remixml</h1>
 
-<b>&amp;</b> &nbsp; <i>scope</i> &nbsp;
- <b>.</b> &nbsp; <i>variablename</i> &nbsp;
- <b>:</b> &nbsp; <i>encoding</i> &nbsp;
- <b>%</b> &nbsp; <i>formatting</i> &nbsp; <b>;</b>
+`& scope . variablename : encoding % formatting ;`
 
-- <i>scope</i><br />
+- `scope`<br />
   References the primary level in the variables object (the second
   argument to parse()).
-- <i>variablename</i><br />
+- `variablename`<br />
   References second and deeper levels in the variables
   object (can contain multiple dots to designate deeper levels, is used
   to access both objects and arrays).
-- <i>encoding</i> (optional)<br />
+- `encoding` (optional)<br />
   Specifies the encoding to be used when substituting the variable.
   The encodings available are:
-    - html<br />
+    - `html`<br />
       Default, encodes using
       [HTML entities](https://dev.w3.org/html5/html-author/charref).
-    - uric<br />
+    - `uric`<br />
       URI component, encodes URI arguments in an URL.
-    - json<br />
+    - `json`<br />
       Encodes as a [JSON](https://www.json.org/) string.
-    - none<br />
+    - `none`<br />
       No encoding, as is, can be abbreviated as ":;".
-- <i>formatting</i> (optional)<br />
+- `formatting` (optional)<br />
   [printf()-like formatting
@@ -89,7 +86,135 @@ specification](https://en.wikipedia.org/wiki/Printf_format_string)
 Note: the entity reference must not contain spaces (the spaces shown
-above are there to clarify the format, they cannot be used in a real
+above are there to clarify the format, they should not be used in a real
 entity reference).
 
-### Language statements
+### Language tags
 
+- `<set var="" expr="" split="" join="" tag="" scope="">...</set>`<br />
+   Attributes:
+   - `var`<br />
+     Assign to the named variable.
+   - `expr`<br />
+     Use the javascript expression specified in this attribute.
+     Or, alternately, if the attribute is empty, a javascript from
+     the content of this tag is stored.
+   - `regexp`<br />
+     A regular expression to match the content to.
+   - `split`<br />
+     Split the content on this value; if used together with <i>regexp</i>,
+     it will [split the content using a regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split).
+   - `join`<br />
+     Join an array using the specified separator.
+   - `tag`<br />
+     Declare a custom tag.  <i>&amp;_._contents;</i> can be used to reference
+     the contents of the tag.  All argument values are accessible
+     as variables from the local scope (<b>_</b>).  E.g. an attribute
+     foo="bar" can be referenced as <i>&amp;_.foo;</i> inside the tag definition.
+   - `scope`<br />
+     Create a toplevel alias for the local scope in this tag definition.
+- `<if expr="">...</if>`<br />
+   Attributes:
+   - `expr`<br />
+     If the Javascript expression evaluates to true, include the
+     content of the <b>if</b> tag.
+- `<then>...</then>`<br />
+     If the last truth value was true, include the content
+     of the <b>then</b> tag.  Not needed for a typical if/else
+     construction; usually used after a <b>for</b> tag
+     to specify code that needs to included if the <b>for</b> tag
+     actually completed at least one iteration.
+- `<elif expr="">...</elif>`<br />
+   Attributes:
+   - `expr`<br />
+     If the last truth value was false and the Javascript expression evaluates
+     to true, include the content of the <b>elif</b> tag.
+- `<else>...</else>`<br />
+     If the last truth value was false, include the content of
+     the <b>else</b> tag.  Can also be used after a <b>for</b> to specify
+     code that needs to be included if the <b>for</b> tag did not iterate
+     at all.
+- `<for from="" to="" step="" in="" orderby="" scope="">...</for>`<br />
+   Upon iteration the following special variables are defined:
+   - `&_._recno;`<br />
+     Starts at 1 and counts up per iteration.
+   - `&_._index;`<br />
+     Contains the current loopindex for counted loops, or the index
+     for iterations through arrays, or
+     the key of the current element for iterations through objects.
+   - `&_._value;`<br />
+     Contains the current value for iterations through arrays or objects.
+
+   Attributes:
+   - `from`<br />
+     Start counting <i>from</i> here (defaults to 0).
+   - `to`<br />
+     Count up till and including <i>to</i>.
+   - `step`<br />
+     Stepsize (defaults to 1).
+   - `in`<br />
+     Iterate through the named variable (the variable needs to contain
+     either an array or an object).
+   - `orderby`<br />
+     A comma-separated list of Javascript variable expressions to sort an
+     iteration
+     through an object by.  When the function <b>desc()</b> is applied to
+     the expression, the order of that expression will be reversed.
+   - `scope`<br />
+     Create a toplevel alias for the local scope in the current for loop.
+- `<delimiter>...</delimiter>`<br />
+   Should be used inside a <b>for</b> loop.  It will suppress its content
+   upon the first iteration.
+- `<insert var="" quote="" format="" offset="" limit=""
+     variables=""></insert>`<br />
+   More explicit way to access variable content instead of through
+   entities.
+   Attributes:
+   - `var`<br />
+     Variable name to be inserted.  Typically convenient to index objects
+     using a different variable content as the index.
+   - `quote`<br />
+     Quote method (see entities).
+   - `format`<br />
+     Format method (see entities).
+   - `offset`<br />
+     Substring index starting at this offset.
+   - `limit`<br />
+     Substring limit the total number of characters.
+   - `variables`<br />
+     Insert a variable group:
+     - `dump`<br />
+       Insert a JSON encoded dump of all accessible variables.
+- `<replace from="" regexp="" flags="" to="">...</replace>`<br />
+   Attributes:
+   - `from`<br />
+     Search in the content of this tag for this text.
+   - `regexp`<br />
+     Search for this regular expression.
+   - `flags`<br />
+     [Regular expression flags](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions).
+   - `to`<br />
+     Replace found occurrences with this text.
+- `<trim>...</trim>`<br />
+   Truncates whitespace at both ends, and reduce other whitespace runs of
+   more than one character to a single space.
+- `<maketag name="">...</maketag>`<br />
+   Attributes:
+   - `name`<br />
+     Construct a new tag inline using this name.
+   Subtags:
+   - `<attrib name="">...</attrib>`<br />
+     Attributes:
+     - `name`<br />
+     Add attributes to the tag with these names and values.
+     The <b>attrib</b> subtags need to be at the beginning
+     of the <b>maketag</b>.
+- `<eval>...</eval>`<br />
+   Reevaluate the content (e.g. useful to execute a tag
+   created with <b>maketag</b>).
+- `<nooutput>...</nooutput>`<br />
+   Suppress output inside this tag.
+- `<comment>...</comment>`<br />
+   Skip the content of this tag.
+
+### Examples
+
 Simple assigment:
@@ -132,4 +257,5 @@
 ```html
-<for in="&_.variablename;">
- This is line &_._recno;<br />
+<set var="_.foo" split=",">aa,b,cc,d,eee,f</set>
+<for in="_.foo">
+ This is record &_._recno; value: &_._value;<br />
 </for>
@@ -140,5 +266,34 @@ ```
 
+Specified parameters:
+- `template`<br />
+  Can be a domNode, documentFragment, or text-html.
+- `context`<br />
+  Optional argument which specifies an object which can be referenced
+  from within Remixml code.  The toplevel entries are the toplevel scopes
+  in Remixml.  Within the Remixml Javascript, this object will always be
+  referenced using a single `$`.  The local scope will always exist
+  as `$._` and that can always be referenced using a direct `_`
+  shortcut.  I.e. in Javascript `$._.foo` and `_.foo` will both refer
+  to the same variable.
+
+Exposed API-list:
+- `template = Remixml.parse(template, context);`<br />
+  Destructively parses the template.  If you want to reuse the template,
+  clone it first.
+- `txt = Remixml.parse2txt(template, context);`<br />
+  Destructively parses the template, returns the result as a string
+  (convenience function for dom2txt(parse())).
+- `template = Remixml.parse_tagged(template, context);`<br />
+  Destructively parses the template, but only touches regions
+  enclosed in `<remixml>...</remixml>  tags.
+- `domtop = Remixml.parse_document(context);`<br />
+  Destructively parses the whole current page document.
+- `txt = Remixml.dom2txt(template);<br />
+  Destructively converts the domNode(s) to a string.
+- `template = Remixml.trim(template);`<br />
+  Trims whitespace like the Remixml `<trim>` tag.
+
 #### Reserved object variables
 
-- $.sys.lang<br />
+- `$.sys.lang`<br />
   If set, it overrides the default locale of the browser environment
@@ -149,4 +304,2 @@ (currently only used during currency formatting).
 
-Soon to be launched:
-
 - The [Remixml website](http://remixml.org/).
@@ -153,0 +306,0 @@ - For historical reference:<br />

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29072

increased by28.94%

Number of lines in readme file

305

increased by100.66%

No dependency changes