+ Simplified project manifest in version 2 format
Configuration is achieved via a hidden file at the top of your home directory, namely .aspell.conf. A Mac will try to keep you away from hidden files, which are the ones whose name begins with a period. Let SublimeText give you an assist here. In we show a first run at a useful configuration file. You definitely want to add the SGML filter, since this is what tells Aspell that you are working on XML filesSGML is the precursor of XML., so that all element names, attributes, etc. will not be checked. The remainder is a suggested list of elements to skip. Suggestions for additions are welcome here.
-
+ Example of version 2 executables file
\\s. Use \amp to mark the alignm
]]>
-
Possible structures for using mathcmp within a test. The de-expression would be replaced by any valid construction as described for the setup.
+ Possible structures for using mathcmp within a test. The de-expression would be replaced by any valid construction as described for the setup.
Compound logical structures are created using the logic element in the place of a comparison. To specify which operation is being used, the op attribute is set to one of op="and", op="or", or op="not". The operations are considered n-ary, meaning that the contents should be one or more comparison elements, which might include additional logic. The op="and" will evaluate as true when all of the children comparisons evaluate as true. The op="or" will evaluate as true when at least one of the children comparisons evaluates as true. The op="not" is technically implemented as the negation of op="and", and so will evaluate as true when at least one of the children comparisons evaluates as false. In the absence of any logic, there is always an implicit op="and" so that any sequence of comparisons within a single test, all comparisons are required to evaluate as true.
@@ -3442,7 +3442,7 @@ displayed line, and there are no \\s. Use \amp to mark the alignm
A console is a transcript of an interactive session in a terminal or console at a command-line. It is a sequence of the following elements, in this order, possibly repeated many times as a group: input, and output. The output is optional. The content of these two elements is treated as verbatim text (see ), subject to all the exceptions for exceptional characters (see ). A prompt attribute on the input can be supplied to provide a system prompt distinct from the actual commands. The default prompt is a dollar sign followed by a space. If it is more convenient prompt may be supplied on the console, to be used in each enclosed input. If you do not want any prompts at all, just use an empty value for prompt.
-
A program or console may be wrapped in a listing, see . This will behave similar to a figure, with the caption displayed below, and a number assigned. So, in particular, if your program or console is important enough to cross-reference, it is an enclosing listing that serves as the target.
+
A program or console may be wrapped in a listing, see . This will behave similar to a figure, with the title displayed above, and a number assigned. So, in particular, if your program or console is important enough to cross-reference, it is an enclosing listing that serves as the target.
The language attribute may be used to get some degree of language-specific syntax highlighting and/or interactive behavior. We will eventually provide a table of attribute values here. They are always lowercase, and a good first guess is likely to succeed.
@@ -3921,7 +3921,7 @@ displayed line, and there are no \\s. Use \amp to mark the alignm
Program Listings
-
A listing is really a specialized type of figure, whose purpose is to hold computer code. Just like a figure, it has a caption and title which behave identically. However, the enclosed planar content is limited to a program or console (see ).
+
A listing is really a specialized type of figure, whose purpose is to hold computer code. It has an optional title which is rendered above the listing. However, the enclosed planar content is limited to a program or console (see ).
+ An ordered listlistordered code forordered list code for code forordered list
@@ -356,7 +356,7 @@
-
An unordered list
+ An unordered listlistunordered code forunordered list code for code forunordered list
@@ -409,7 +409,7 @@
-
A theorem
+ A theoremtheorem code for code fortheorem-like elements (algorithm, claim, corollary, fact, identity, lemma, proposition, theorem)theorem-like elements (algorithm, claim, corollary, fact, identity, lemma, proposition, theorem) code for
@@ -457,7 +457,7 @@
-
A definition with notation
+ A definition with notationdefinition code for code fordefinitionnotation (to be included in a notation list) code for
@@ -519,7 +519,7 @@
-
A simple example
+ A simple exampleexample-like elements (example, problem, question)unstructured code forexampleunstructured code for code forexampleunstructured
@@ -544,7 +544,7 @@
-
A structured example
+ A structured exampleexamplestructured code for code forexamplestructured code forexample-like elements (example, problem, question)
@@ -585,7 +585,7 @@
-
An axiom
+ An axiomaxiom code for code foraxiom-like elements (assumption, axiom, conjecture, heuristic, hypothesis, principle)axiom-like elements (assumption, axiom, conjecture, heuristic, hypothesis, principle) code for
@@ -626,7 +626,7 @@
-
A remark
+ A remarkremark code for code forremark-like elements (convention, insight, note, observation, remark, warning)remark-like elements (convention, insight, note, observation, remark, warning) code for
@@ -661,7 +661,7 @@
-
A project
+ A projectproject code for code forproject-like elements
(activity, exploration, investigation, project)
@@ -708,7 +708,7 @@
-
An exercise
+ An exerciseexercise code forinline exercise code for code forexerciseinline
@@ -751,7 +751,7 @@
such an exercise.
-
An exercise with tasks
+ An exercise with tasksexercisewith task code for code for
-
Using an exercisegroup.
+ Using an exercisegroup.exercisegroup code for code forexercisegroup
@@ -882,7 +882,7 @@
-
Structure of reading-questions.
+ Structure of reading-questions.reading-questions code for code forreading-questions
@@ -944,7 +944,7 @@
-
Structure of worksheet.
+ Structure of worksheet.worksheet code for code forworksheet
@@ -980,7 +980,7 @@
-
A porism generated using algorithm and rename
+ A porism generated using algorithm and rename
@@ -1061,7 +1061,7 @@
so that's a good option when vector graphic formats like SVG and PDF are not available or appropriate.
-
Code to include an image without a number or caption
+ Code to include an image without a number or captionimage code for code forimagedescriptionof image
@@ -1108,7 +1108,7 @@
the figure but is displayed below the
figure's content.
-
Code to include a figure
+ Code to include a figurefigure code for code forfigurecaptionof figure
@@ -1156,7 +1156,7 @@
-
Code to place things side by side
+ Code to place things side by sidesidebyside code for code forsidebysidefigureinside sidebyside
@@ -1176,7 +1176,7 @@
-
A few more bells and whistles for sidebyside
+ A few more bells and whistles for sidebysidesidebyside code for code forsidebysidefigurecontaining sidebyside
@@ -1199,7 +1199,7 @@
-
Use of sbsgroup
+ Use of sbsgroupsbsgroup code for code forsbsgroup
@@ -1271,7 +1271,7 @@
-
How to use latex-image to invoke TikZ
+ How to use latex-image to invoke TikZlatex-image code for code forlatex-imageTikZinside latex-image
@@ -1344,7 +1344,7 @@
Similar to , provides a table tag and a tabular tag. The tabular tag is used for producing the array of data, while the table tag provides the number and title.
-
Code to produce a table
+ Code to produce a tabletable code for code fortabletitleof table
@@ -1415,7 +1415,7 @@
-
+ sageplot to produce a graphicsageplot code for code forsageplot
@@ -1585,7 +1585,7 @@
-
A sample aside
+ A sample asideaside code for code foraside
@@ -1677,7 +1677,7 @@
-
A sample blockquote
+ A sample blockquoteblockquote code for code forblockquote
diff --git a/doc/guide/introduction/start-here.xml b/doc/guide/introduction/start-here.xml
index 171e99602..b6226735b 100644
--- a/doc/guide/introduction/start-here.xml
+++ b/doc/guide/introduction/start-here.xml
@@ -95,7 +95,7 @@
The hierarchical nature of XML is perfect to capture the hierarchical nature of a scholarly document. Consider the start of a document shown in .
-
Source of a simple book project.
+ Source of a simple book project.
.
-
An interactive Python program, using Runestone
+ An interactive Python program, using Runestone
print("Hello, World!")
@@ -9151,7 +9151,7 @@ along with MathBook XML. If not, see .
-
An interactive Python program without codelens.
+ An interactive Python program without codelens.
print("Hello, World!")
@@ -9168,7 +9168,7 @@ along with MathBook XML. If not, see .
-
A Python program, stepable with CodeLens
+ A Python program, stepable with CodeLens
print('Hello, World!')
@@ -10104,10 +10104,10 @@ along with MathBook XML. If not, see .
Note that the above examples all have slightly different widths (theser are very evident in print with the frames). As 2-D atomic objects, to place them in the narrative requires the layout features of a sidebyside element. Then width and/or margin attributes will influence the width of the panel.
-
A program may also be nested inside a listing, which behaves similar to a figure. You can provide a caption, and the listing will be numbered along with tables and figures. This then makes it possible to cross-reference the listing, such as . It also removes the requirement of wrapping the program in a sidebyside. For technical reasons, the three examples above will not split across a page break in PDF output, but the placement inside a listing will allow splits, as you should see in at least one example following.
+
A program may also be nested inside a listing, which behaves similar to a figure. You can provide a title, and the listing will be numbered along with tables and figures. This then makes it possible to cross-reference the listing, such as . It also removes the requirement of wrapping the program in a sidebyside. For technical reasons, the three examples above will not split across a page break in PDF output, but the placement inside a listing will allow splits, as you should see in at least one example following.
-
C Version of Hello, World!
+ C Version of Hello, World!
/* Hello World program */
@@ -10125,7 +10125,7 @@ along with MathBook XML. If not, see .
A program may include line numbers.
-
A static Java program with line numbers
+ A static Java program with line numbers
import javax.swing.JFrame; //Importing class JFrame
@@ -10147,7 +10147,7 @@ along with MathBook XML. If not, see .
A program may also include highlighted lines.
-
A static Java program with line numbers
+ A static Java program with line numbers
import javax.swing.JFrame; //Importing class JFrame
@@ -10209,7 +10209,7 @@ along with MathBook XML. If not, see .
A specialized version of a program listing is an interactive command/response session at a command-line, where differing fonts are used to differentiate the system prompt, the user's commands, and the system's reaction. A console session may be used by itself inside a sidebyside, or it can be wrapped in a listing to get a number and a caption. As elsewhere, you will need to escape ampersands and angle brackets (such as if you have a command using redirection), using &, <, and > in your source.
-
Console Session: int and float
+ Console Session: int and float
gcc -Wall -o intAndFloat intAndFloat.c
./intAndFloat
@@ -10234,7 +10234,7 @@ along with MathBook XML. If not, see .
If your console input exceeds more than one line, you can author it across several lines and your choice of line breaks will be reflected in the rendering. You can decide to indent lines after the first one for clarity, if desired. You can also decide if your audience needs line-continuation characters or not.
-
Console Session: int and float (multi-line input)
+ Console Session: int and float (multi-line input)
gcc -Wall
@@ -10253,7 +10253,7 @@ along with MathBook XML. If not, see .
The next listing is just absurdity, to check various characters from that are otherwise employed by the code supporting consoles, and some Latin-1 characters. We test each in a prompt, input, and output. We use (* and *) as sequences used to escape embedded commands, so we test those also.
-
Console Session: problematic characters
+ Console Session: problematic characters
A backslash \ here
@@ -10284,7 +10284,7 @@ along with MathBook XML. If not, see .
We conclude this section with a longer example of a program listing, an assembly language program from Bob Plantz, included to test a listing breaking across pages in PDF output.
-
A longer program listing
+ A longer program listing
@ structPass2.s
@@ -11992,7 +11992,7 @@ along with MathBook XML. If not, see .
A listing and a list
-
A statistical computation
+ A statistical computation
n_loops <- 10
@@ -12403,7 +12403,7 @@ along with MathBook XML. If not, see .
inside a sidebyside, with size and layout configured, and inside a figure
inside a sidebyside, with size and layout configured, with each inside a listing, earning different numbers
-
inside a figure inside a sidebyside inside a listing, with size and layout configured, with a number and caption, but now sub-numbered ((a), (b), (c),).
+
inside a figure inside a sidebyside inside a listing, with size and layout configured, with a number and title, but now sub-numbered ((a), (b), (c),).
Examples of each, and more.
Programs can be realized in many forms, and can come from a variety of sources. See for tests of some of that variety. Here we are testing placement within surroundings and testing the schema for location. But we do have two videos in each test, one provided as a local file and one embedded from a service.
@@ -12490,10 +12490,10 @@ along with MathBook XML. If not, see .
-
Two listing, with caption, and no layout control.
+
Two listing, with title, and no layout control.
-
Hello, World! in C
+ Hello, World! in C
/* Hello World program */
@@ -12509,7 +12509,7 @@ along with MathBook XML. If not, see .
-
A console session on a Raspberry Pi
+ A console session on a Raspberry Pi
gcc -Wall -o intAndFloat intAndFloat.c
./intAndFloat
@@ -12523,7 +12523,7 @@ along with MathBook XML. If not, see .
Same two listing, but now with layout control on the program and console.
-
Hello, World! in C
+ Hello, World! in C
/* Hello World program */
@@ -12539,7 +12539,7 @@ along with MathBook XML. If not, see .
-
A console session on a Raspberry Pi
+ A console session on a Raspberry Pi
gcc -Wall -o intAndFloat intAndFloat.c
./intAndFloat
@@ -12631,7 +12631,7 @@ along with MathBook XML. If not, see .
-
Hello!
+ Hello!
/* Hello World program */
@@ -12646,7 +12646,7 @@ along with MathBook XML. If not, see .
-
Raspberry Pi
+ Raspberry Pi
gcc -Wall -o intAndFloat intAndFloat.c
./intAndFloat
@@ -12658,14 +12658,14 @@ along with MathBook XML. If not, see .
-
And again, the two-panel sidebyside of listing, but now inside a figure that has a number and a caption. And then the listing are sub-numbered as (a) and (b).
+
And again, the two-panel sidebyside of listing, but now inside a figure that has a number and a title. And then the listing are sub-numbered as (a) and (b).