on master help sign in
fixing sail runes
a2888ecjoshuareagan
docs/reference/rune/mic/lus.udon+25−11
@@ -7,11 +7,11 @@
7
7
8# `;+ "miclus"`
8# `;+ "miclus"`
9
9
10−make an XML node (Sail)
10+make a single XML node (Sail)
11
11
12## Produces
12## Produces
13
13
14−A noun that represents a single XML node.
14+A `marl`, i.e., a list of `manx`. A `manx` is a noun that represents a single XML node.
15
15
16## Syntax
16## Syntax
17
17
@@ -21,31 +21,45 @@ A noun that represents a single XML node.
21;+ p=hoon
21;+ p=hoon
22```
22```
23
23
24−`p` is a Hoon expression.
24+`p` is a Hoon expression that produces a `manx`.
25
25
26## Discussion
26## Discussion
27
27
28−This is a Sail rune. Sail is a part of Hoon used for creating and operating on nouns that represent XML nodes. Among other things it can be used to generate a static website using the appropriate render pipeline. See the [Sail tutorial](../../../../tutorial/sail).
28+tl;dr -- `;+` converts a `manx` to a `marl`.
29
29
30+`;+` is a Sail rune. Sail is a part of Hoon used for creating and operating on nouns that represent XML nodes. With the appropriate rendering pipeline, a Sail document can be used to generate a static website. See the [Sail tutorial](../../../../tutorial/sail).
31+
30−In Sail you can produce a single `<p>` node very simply in the following way:
32+In Sail a single XML node is represented by a `manx`. A single `<p>` node `manx` can be produced in the following way:
31
33
32```
34```
33> ;p: This will be rendered as an XML node.
35> ;p: This will be rendered as an XML node.
34[[%p ~] [[%$ [%$ "This will be rendered as an XML node."] ~] ~] ~]
36[[%p ~] [[%$ [%$ "This will be rendered as an XML node."] ~] ~] ~]
35```
37```
36
38
39+Sometimes what is needed is a `marl`, i.e., a list of `manx`. To convert a single `manx` to a `marl`, use the `;+` rune.
40+
37−One interesting thing about Sail is that it allows you to use complex Hoon expressions to choose from among several nodes to render. This is done with the `;+` rune.
41+One interesting thing about Sail is that it allows you to use complex Hoon expressions to choose from among several nodes to render. The `;+` rune can take such a complex expression.
38
42
39## Examples
43## Examples
40
44
41```
45```
46+> ^- marl
42−> ;+ ?: (gth 3 2)
47+ ;+ ?: (gth 3 2)
43 ;p: This is the node for 'yes'.
48 ;p: This is the node for 'yes'.
44 ;p: This is the node for 'no'.
49 ;p: This is the node for 'no'.
50+~[
51+ [ g=[n=%p a=~]
45−[[[%p ~] [[%$ [%$ "This is the node for 'yes'."] ~] ~] ~] ~]
52+ c=[i=[g=[n=%$ a=~[[n=%$ v="This is the node for 'yes'."]]] c=~] t=~]
46−
53+ ]
54+]
55+
56+> ^- marl
47−> ;+ ?: (gth 2 3)
57+ ;+ ?: (gth 2 3)
48 ;p: This is the node for 'yes'.
58 ;p: This is the node for 'yes'.
49 ;p: This is the node for 'no'.
59 ;p: This is the node for 'no'.
60+~[
61+ [ g=[n=%p a=~]
50−[[[%p ~] [[%$ [%$ "This is the node for 'no'."] ~] ~] ~] ~]
62+ c=[i=[g=[n=%$ a=~[[n=%$ v="This is the node for 'no'."]]] c=~] t=~]
63+ ]
64+]
51```
65```
docs/reference/rune/mic/tar.udon+8−13
@@ -7,34 +7,29 @@
7
7
8# `;* "mictar"`
8# `;* "mictar"`
9
9
10−make a list of XML nodes from a tuple (Sail)
10+make a list of XML nodes from complex Hoon expression (Sail)
11
11
12## Produces
12## Produces
13
13
14−A list of nouns, each of which represents an XML node.
14+A `marl`, i.e., a list of `manx`. A `manx` is a noun that represents a single XML node.
15
15
16## Syntax
16## Syntax
17
17
18−*running*
18+*1-fixed*
19
19
20```
20```
21−;* p=hoon q=hoon ... z=hoon ==
21+;* p=hoon
22```
22```
23
23
24−`p`-`z` are Hoon expressions.
24+`p` is a Hoon expression that produces a `marl`.
25
25
26## Discussion
26## Discussion
27
27
28−This is a Sail rune. Sail is a part of Hoon used for creating and operating on nouns that represent XML nodes. Among other things it can be used to generate a static website using the appropriate render pipeline. See the [Sail tutorial](../../../../tutorial/sail).
28+`;*` is a Sail rune. Sail is a part of Hoon used for creating and operating on nouns that represent XML nodes. With the appropriate rendering pipeline, a Sail document can be used to generate a static website. See the [Sail tutorial](../../../../tutorial/sail).
29
29
30−In Sail you can produce a single `<p>` node very simply in the following way:
30+If you need a complex Hoon expression to produce a `marl`, use the `;*` rune. Often this rune is used with an expression, `p`, that includes one or more `;=` subexpressions.
31
31
32−```
32+(See also [;=](./tis).)
33−> ;p: This will be rendered as an XML node.
34−[[%p ~] [[%$ [%$ "This will be rendered as an XML node."] ~] ~] ~]
35−```
36−
37−Sometimes you need a list of such nodes, usually produced with the `;*` rune. But to use this rune appropriately you must first put the desired nodes together with `;=`.
38
33
39## Examples
34## Examples
40
35
docs/reference/rune/mic/tis.udon+7−7
@@ -7,11 +7,11 @@
7
7
8# `;= "mictis"`
8# `;= "mictis"`
9
9
10−make a tuple of XML nodes (Sail)
10+make a list of XML nodes (Sail)
11
11
12## Produces
12## Produces
13
13
14−A tuple of nouns, each of which represents an XML node.
14+A `marl`, i.e., a list of `manx`. A `manx` is a noun that represents a single XML node.
15
15
16## Syntax
16## Syntax
17
17
@@ -21,22 +21,22 @@ A tuple of nouns, each of which represents an XML node.
21;= p=hoon q=hoon ... z=hoon ==
21;= p=hoon q=hoon ... z=hoon ==
22```
22```
23
23
24−`p`-`z` are Hoon expressions.
24+`p`-`z` are Hoon expressions, each of which poduces a `manx`.
25
25
26## Discussion
26## Discussion
27
27
28−This is a Sail rune. Sail is a part of Hoon used for creating and operating on nouns that represent XML nodes. Among other things it can be used to generate a static website using the appropriate render pipeline. See the [Sail tutorial](../../../../tutorial/sail).
28+`;=` is a Sail rune. Sail is a part of Hoon used for creating and operating on nouns that represent XML nodes. With the appropriate rendering pipeline, a Sail document can be used to generate a static website. See the [Sail tutorial](../../../../tutorial/sail).
29
29
30−In Sail you can produce a single `<p>` node very simply in the following way:
30+In Sail a single XML node is represented by a `manx`. A single `<p>` node `manx` can be produced in the following way:
31
31
32```
32```
33> ;p: This will be rendered as an XML node.
33> ;p: This will be rendered as an XML node.
34[[%p ~] [[%$ [%$ "This will be rendered as an XML node."] ~] ~] ~]
34[[%p ~] [[%$ [%$ "This will be rendered as an XML node."] ~] ~] ~]
35```
35```
36
36
37−Sometimes you need a list of such nodes, usually produced with the `;*` rune. But to use this rune appropriately you must first put the desired nodes together with `;=`.
37+Sometimes what is needed is a `marl`, i.e., a list of `manx`. To convert a series of `manx` nodes to a `marl`, use the `;=` rune.
38
38
39−(See [`;*`](./tar).)
39+(See also [`;*`](./tar).)
40
40
41## Examples
41## Examples
42
42