From 7c2f3a831dfacec423ea02e8590e0fda6de08291 Mon Sep 17 00:00:00 2001 From: Henrik Tidefelt Date: Thu, 28 Jan 2016 22:25:34 +0100 Subject: [PATCH] Ammend merge: Misc stuff --- doc/build/html/Makefile.am | 16 +-- .../Applications-Blockdraw-blockdraw.sxml | 110 +++++++++---------- .../Applications-Blockdraw-bondgraph.sxml | 6 +- doc/parts/formats/bindings-html.xsl | 11 ++ doc/parts/formats/html.xsl | 20 ++-- doc/parts/guides/formats/html.xsl | 1 + doc/parts/guides/graphs.sxml | 10 +- doc/parts/guides/text.sxml | 6 +- doc/parts/interactive/index.sxml | 4 +- doc/parts/namespace-toc/index.sxml | 2 +- doc/parts/namespace/Shapes-Data.sxml | 37 +++---- doc/parts/namespace/Shapes-Debug.sxml | 4 +- doc/parts/namespace/Shapes-Graphics-Tag.sxml | 4 +- doc/parts/namespace/Shapes-Graphics.sxml | 2 +- doc/parts/namespace/Shapes-Graphics3D.sxml | 8 +- doc/parts/namespace/Shapes-IO.sxml | 8 +- doc/parts/namespace/Shapes-Numeric-Random.sxml | 2 +- doc/parts/namespace/Shapes-String.sxml | 2 +- doc/parts/namespace/Shapes-Text.sxml | 6 +- doc/parts/namespace/Shapes-Traits.sxml | 2 +- doc/parts/namespace/Shapes.sxml | 10 +- doc/parts/state-types/containers.sxml | 16 +-- doc/parts/state-types/formats/html.xsl | 1 + doc/parts/syntax/misc.sxml | 2 +- doc/parts/tutorial/chap-prog.sxml | 2 +- doc/parts/types/containers.sxml | 30 ++--- doc/parts/types/formats/html.xsl | 14 +-- doc/parts/types/graphs.sxml | 122 ++++++++++----------- doc/parts/types/hierarchical-graphs.sxml | 122 ++++++++++----------- doc/parts/types/text.sxml | 2 +- 30 files changed, 290 insertions(+), 292 deletions(-) diff --git a/doc/build/html/Makefile.am b/doc/build/html/Makefile.am index 342b91d5..128c79f2 100644 --- a/doc/build/html/Makefile.am +++ b/doc/build/html/Makefile.am @@ -115,9 +115,9 @@ EXTRA_html_FILES = \ Shapes-Layout-centering-X.html \ Shapes-Layout-shiftoff.html \ Shapes-Numeric-Constant-constants.html \ - ) + ) \ $(addprefix guides/, \ - paths.html 3D.html text.html graphs.html index.html) + paths.html 3D.html text.html graphs.html hierarchical.html index.html) nobase_dist_html_DATA = shapes.css toc-miss.html EXTRA_nobase_dist_html = ${html_FILES} @@ -169,12 +169,12 @@ extensions/%.xml : ${extensionsdir}/%.sxml ${DEPDIR}/extensions/%.ssidep guides/%.xml : ${guidesdir}/%.sxml ${DEPDIR}/guides/%.ssidep test -d $(@D) || ${mkdir_p} $(@D) if ${SSI} --in $< ${SSIFLAGS_SUBTOPIC} > guides/$*.Txml; \ - then \ - mv guides/$*.Txml $@; \ - else \ - ${RM} guides/$*.Txml; \ - exit 1; \ - fi + then \ + mv guides/$*.Txml $@; \ + else \ + ${RM} guides/$*.Txml; \ + exit 1; \ + fi ${DEPDIR}/extensions/%.ssidep : ${extensionsdir}/%.sxml Makefile test -d $(@D) || ${mkdir_p} ${@D} diff --git a/doc/parts/extensions/Applications-Blockdraw-blockdraw.sxml b/doc/parts/extensions/Applications-Blockdraw-blockdraw.sxml index 5d8097b9..37cec7b1 100644 --- a/doc/parts/extensions/Applications-Blockdraw-blockdraw.sxml +++ b/doc/parts/extensions/Applications-Blockdraw-blockdraw.sxml @@ -568,7 +568,7 @@
Layout -

The functions are non-pure, as they have the bad (?) habit of tacking on their return value to a . The reason is that it is almost always convenient to bind a block to a variable so that it can be referred to, and there is seldom reason not to draw it as soon as it is laid out. If one does not want the object to be drawn to any state, one may simply pass as the destination.

+

The functions are non-pure, as they have the bad (?) habit of tacking on their return value to a . The reason is that it is almost always convenient to bind a block to a variable so that it can be referred to, and there is seldom reason not to draw it as soon as it is laid out. If one does not want the object to be drawn to any state, one may simply pass as the destination.

The number of functions in this section may seem overwhelming, but the reason for this is to hide degrees of freedom in order to gain in consistency of the spacing between blocks in the diagram. Except , uses typically select among function being named after two axes for the user to choose from; one distance axis (VeryNear, Near, LabelSpace, Far, VeryFar), and one direction axis (Left, Right, Below, Above). This explains 20 of the functions here. In addition, there are some low-level functions, and another four where the point on the distance axis is LabelMargin (here, the distance depends on the direction, but users typically don't use these functions anyway).

@@ -589,7 +589,7 @@ - + @@ -611,7 +611,7 @@ - + @@ -647,7 +647,7 @@ - + @@ -682,7 +682,7 @@ - + @@ -717,7 +717,7 @@ - + @@ -752,7 +752,7 @@ - + @@ -776,7 +776,7 @@ - + @@ -800,7 +800,7 @@ - + @@ -824,7 +824,7 @@ - + @@ -848,7 +848,7 @@ - + @@ -872,7 +872,7 @@ - + @@ -897,7 +897,7 @@ - + @@ -921,7 +921,7 @@ - + @@ -945,7 +945,7 @@ - + @@ -969,7 +969,7 @@ - + @@ -993,7 +993,7 @@ - + @@ -1017,7 +1017,7 @@ - + @@ -1042,7 +1042,7 @@ - + @@ -1066,7 +1066,7 @@ - + @@ -1090,7 +1090,7 @@ - + @@ -1114,7 +1114,7 @@ - + @@ -1138,7 +1138,7 @@ - + @@ -1162,7 +1162,7 @@ - + @@ -1187,7 +1187,7 @@ - + @@ -1211,7 +1211,7 @@ - + @@ -1235,7 +1235,7 @@ - + @@ -1259,7 +1259,7 @@ - + @@ -1283,7 +1283,7 @@ - + @@ -1307,7 +1307,7 @@ - + @@ -1351,7 +1351,7 @@ - + @@ -1376,7 +1376,7 @@ - + @@ -1401,7 +1401,7 @@ - + @@ -1426,7 +1426,7 @@ - + @@ -1472,7 +1472,7 @@ - + @@ -1496,7 +1496,7 @@ - + @@ -1520,7 +1520,7 @@ - + @@ -1551,7 +1551,7 @@ - + @@ -1593,7 +1593,7 @@ - + @@ -1620,7 +1620,7 @@ - + @@ -1647,7 +1647,7 @@ - + @@ -1674,7 +1674,7 @@ - + @@ -1701,7 +1701,7 @@ - + @@ -1728,7 +1728,7 @@ - + @@ -1755,7 +1755,7 @@ - + @@ -1782,7 +1782,7 @@ - + @@ -1810,7 +1810,7 @@ - + @@ -1845,7 +1845,7 @@ - + @@ -1880,7 +1880,7 @@ - + @@ -1915,7 +1915,7 @@ - + @@ -1951,7 +1951,7 @@ - + @@ -1981,7 +1981,7 @@ - + @@ -2011,7 +2011,7 @@ - + @@ -2041,7 +2041,7 @@ - + @@ -2082,7 +2082,7 @@ - + diff --git a/doc/parts/extensions/Applications-Blockdraw-bondgraph.sxml b/doc/parts/extensions/Applications-Blockdraw-bondgraph.sxml index 4ba27622..d46e8c40 100644 --- a/doc/parts/extensions/Applications-Blockdraw-bondgraph.sxml +++ b/doc/parts/extensions/Applications-Blockdraw-bondgraph.sxml @@ -219,7 +219,7 @@ ]]> -

Terminals with bonds. The terminal, positioned at the plus mark, is connected with the serial junction. The non-pure fuctions and will add the terminal label to a state and return the path for the bond. The path is then stroked with an arrowhead to indicate its extent and direction.

+

Terminals with bonds. The terminal, positioned at the plus mark, is connected with the serial junction. The non-pure fuctions and will add the terminal label to a state and return the path for the bond. The path is then stroked with an arrowhead to indicate its extent and direction.

@@ -228,7 +228,7 @@ - + @@ -258,7 +258,7 @@ - + diff --git a/doc/parts/formats/bindings-html.xsl b/doc/parts/formats/bindings-html.xsl index 5413dd2f..f40c726b 100644 --- a/doc/parts/formats/bindings-html.xsl +++ b/doc/parts/formats/bindings-html.xsl @@ -416,6 +416,17 @@ ..Shapes void + true + + + + + false + + + + + true diff --git a/doc/parts/formats/html.xsl b/doc/parts/formats/html.xsl index 3b07d1d1..3e2df332 100644 --- a/doc/parts/formats/html.xsl +++ b/doc/parts/formats/html.xsl @@ -155,7 +155,7 @@ algo-tol.html man.html tutorial.html - guides.html + guides/index.html extensions/index.html install.html interactive.html @@ -403,8 +403,8 @@ discrete - stete-types#statetype: - + state-types#statetype: + @@ -431,11 +431,6 @@ - - - - - @@ -446,6 +441,11 @@ §• + + + + + @@ -953,7 +953,7 @@ -    +    @@ -961,7 +961,7 @@ -    +    diff --git a/doc/parts/guides/formats/html.xsl b/doc/parts/guides/formats/html.xsl index 2a87cda3..f842f1c8 100644 --- a/doc/parts/guides/formats/html.xsl +++ b/doc/parts/guides/formats/html.xsl @@ -22,6 +22,7 @@ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + diff --git a/doc/parts/guides/graphs.sxml b/doc/parts/guides/graphs.sxml index c3db8985..e19fb83c 100644 --- a/doc/parts/guides/graphs.sxml +++ b/doc/parts/guides/graphs.sxml @@ -70,9 +70,9 @@ Extending the example so that each node also contains some arbitrary data is no Basic graph construction

A graph in consists of nodes, edges, and a set of flags describing the graph's domain. Edges can be directed or undirected, may or may not have identical source and target nodes, and may or may not have parallel edges. The graph's domain tells what kind of edges that are allowed in the graph. For instance, the graph of hyperlinks between pages on the web could contain parallel edges, so even if a particular hyperlink graph happens to not have any parallel edges, the graph domain should allow for non-unique edges.

-

Each node in a graph needs to be associated with a key which is unique within the graph. The key may be a (suitable for manual graph construction) or an (suitable for programmatic construction). The keys can be used later to reference a node in the graph, and are used to specify the sources and targets of edges during construction. Each node may also hold a value which defaults to .

-

Edges are specified as either directed or undirected, with source and target nodes (the order of which is unimportant for undirected edges) specified by the node keys. Each node may also hold a value which defaults to .

-

Graphs can be constructed both using the constructor and sequentially using a local state. Using the graph constructor, a directed graph can be constructed like this: +

Each node in a graph needs to be associated with a key which is unique within the graph. The key may be a (suitable for manual graph construction) or an (suitable for programmatic construction). The keys can be used later to reference a node in the graph, and are used to specify the sources and targets of edges during construction. Each node may also hold a value which defaults to .

+

Edges are specified as either directed or undirected, with source and target nodes (the order of which is unimportant for undirected edges) specified by the node keys. Each node may also hold a value which defaults to .

+

Graphs can be constructed both using the constructor and sequentially using a local state. Using the graph constructor, a directed graph can be constructed like this:

 
 

-

The constructor uses a feature which is currently not documented and not having the full status of a true language feature. It is that the way a built-in function accesses the elements of the structure is by passing the structure as arguments to an internal receiver function. Since a function can take arguments both given by name and by position, this means that the member of the structure may be positional rather than named. This is very convenient when a small struct like a is used a several times in a row, and it is clear from the context how the ordered members of the structure will be used.

+

The constructor uses a feature which is currently not documented and not having the full status of a true language feature. It is that the way a built-in function accesses the elements of the structure is by passing the structure as arguments to an internal receiver function. Since a function can take arguments both given by name and by position, this means that the member of the structure may be positional rather than named. This is very convenient when a small struct like a is used a several times in a row, and it is clear from the context how the ordered members of the structure will be used.

It is not reccomended to use ordered members this way unless the structures are constructed very close to the point where they are consumed by the built-in function.

-

It is easy to associate values with nodes and edges. For a node, the value is given as the second member of , and for an edge it is the third member of . Using the constructur, it can look like this: +

It is easy to associate values with nodes and edges. For a node, the value is given as the second member of , and for an edge it is the third member of . Using the constructur, it can look like this:

  'a `pear´ <) (> 'b `apple´ <) (> 'c `orange´ <) (> 'd `melon´ <)]
diff --git a/doc/parts/guides/text.sxml b/doc/parts/guides/text.sxml
index 9b46034e..6fc9dc70 100644
--- a/doc/parts/guides/text.sxml
+++ b/doc/parts/guides/text.sxml
@@ -28,15 +28,15 @@
   
     

provides an interface to the text capabilities of . Compared to using for typesetting, this will compile faster and yield smaller output files, while is your friend if you need to typeset maths or simply want typesetting consistency with other material produced using .

-

This guide is not yet written. In the meantime, please refer to , and the silly example below.

+

This guide is not yet written. In the meantime, please refer to , and the silly example below.

- + ]]> -

Using a state for producing typeset text, and then show that the computed bounding box is correct.

+

Using a state for producing typeset text, and then show that the computed bounding box is correct.

diff --git a/doc/parts/interactive/index.sxml b/doc/parts/interactive/index.sxml index d0e123a7..eba31d3e 100644 --- a/doc/parts/interactive/index.sxml +++ b/doc/parts/interactive/index.sxml @@ -97,8 +97,8 @@ is expanded to
Debugging using the interactive mode -

In every environment that is set up for interactive evaluation there is a state, and it is through this the user can do typical debugging tasks such as setting breakpoints, stepping the program, and inspecting various aspects of the evaluation. The state is of type , and the documentation of this type is to be considered the main reference for . In this section, is described in tutorial style, along with some additional information that is key to understanding the debugging facility.

-

Most mutators of have abbreviated aliases to allow them to be typed quickly at the debug prompt. Here, the abbreviated forms will be used in code examples, while the longer names are used in running text. If there is an abbreviated form, it can always be found by following the link to the reference documentation for the mutator in question.

+

In every environment that is set up for interactive evaluation there is a state, and it is through this the user can do typical debugging tasks such as setting breakpoints, stepping the program, and inspecting various aspects of the evaluation. The state is of type , and the documentation of this type is to be considered the main reference for . In this section, is described in tutorial style, along with some additional information that is key to understanding the debugging facility.

+

Most mutators of have abbreviated aliases to allow them to be typed quickly at the debug prompt. Here, the abbreviated forms will be used in code examples, while the longer names are used in running text. If there is an abbreviated form, it can always be found by following the link to the reference documentation for the mutator in question.

Getting started diff --git a/doc/parts/namespace-toc/index.sxml b/doc/parts/namespace-toc/index.sxml index 70c6c907..2d37911f 100644 --- a/doc/parts/namespace-toc/index.sxml +++ b/doc/parts/namespace-toc/index.sxml @@ -56,7 +56,7 @@ - + diff --git a/doc/parts/namespace/Shapes-Data.sxml b/doc/parts/namespace/Shapes-Data.sxml index a8bfd3fd..fe468ef6 100644 --- a/doc/parts/namespace/Shapes-Data.sxml +++ b/doc/parts/namespace/Shapes-Data.sxml @@ -43,7 +43,7 @@ Sequences - + @@ -52,7 +52,7 @@ - +