Changeset 6587f9d

Timestamp:

Jun 29, 2023, 12:13:51 PM (10 months ago)

Author:

Peter A. Buhr <pabuhr@…>

Branches:

master

Children:

3d70ca9

Parents:

85a3806

Message:

update user manual from old separator manipulator names to new names

File:

• doc/user/user.tex (modified) (9 diffs)

doc/user/user.tex

@@ -11 +11 @@
 %% Created On       : Wed Apr  6 14:53:29 2016
 %% Last Modified By : Peter A. Buhr
-%% Last Modified On : Mon Jun  5 21:18:29 2023
-%% Update Count     : 5521
+%% Last Modified On : Thu Jun 29 11:53:10 2023
+%% Update Count     : 5523
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -3981 +3981 @@
 
 The following \Index{manipulator}s control \Index{implicit output separation}.
-The effect of these manipulators is global for an output stream (except ©sepOn© and ©sepOff©).
+The effect of these manipulators is global for an output stream (except ©sep© and ©nosep©).
 \begin{enumerate}
 \item
-\Indexc{sepSet}\index{manipulator!sepSet@©sepSet©} and \Indexc{sep}\index{manipulator!sep@©sep©}/\Indexc{sepGet}\index{manipulator!sepGet@©sepGet©} set and get the separator string.
+\Indexc{sepSet}\index{manipulator!sepSet@©sepSet©} and \Indexc{sepVal}\index{manipulator!sepVal@©sepVal©}/\Indexc{sepGet}\index{manipulator!sepGet@©sepGet©} set and get the separator string.
 The separator string can be at most 16 characters including the ©'\0'© string terminator (15 printable characters).
 \begin{cfa}[belowskip=0pt]
 sepSet( sout, ", $\LstStringStyle{\textdollar}$" ); $\C{// set separator from " " to ", \$"}$
-sout | 1 | 2 | 3 | " \"" | ®sep® | "\"";
+sout | 1 | 2 | 3 | " \"" | ®sepVal® | "\"";
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt]
@@ -4019 +4019 @@
 
 \item
-\Indexc{sepSetTuple}\index{manipulator!sepSetTuple@©sepSetTuple©} and \Indexc{sepTuple}\index{manipulator!sepTuple@©sepTuple©}/\Indexc{sepGetTuple}\index{manipulator!sepGetTuple@©sepGetTuple©} get and set the tuple separator-string.
+\Indexc{sepSetTuple}\index{manipulator!sepSetTuple@©sepSetTuple©} and \Indexc{sepTupleVal}\index{manipulator!sepTupleVal@©sepTupleVal©}/\Indexc{sepGetTuple}\index{manipulator!sepGetTuple@©sepGetTuple©} get and set the tuple separator-string.
 The tuple separator-string can be at most 16 characters including the ©'\0'© string terminator (15 printable characters).
 \begin{cfa}[belowskip=0pt]
 sepSetTuple( sout, " " ); $\C{// set tuple separator from ", " to " "}$
-sout | t1 | t2 | " \"" | ®sepTuple® | "\"";
+sout | t1 | t2 | " \"" | ®sepTupleVal® | "\"";
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt]
@@ -4038 +4038 @@
 
 \item
-\Indexc{sepDisable}\index{manipulator!sepDisable@©sepDisable©} and \Indexc{sepEnable}\index{manipulator!sepEnable@©sepEnable©} globally toggle printing the separator.
+\Indexc{sepOff}\index{manipulator!sepOff@©sepOff©} and \Indexc{sepOn}\index{manipulator!sepOn@©sepOn©} globally toggle printing the separator.
 \begin{cfa}[belowskip=0pt]
-sout | sepDisable | 1 | 2 | 3; $\C{// turn off implicit separator}$
+sout | sepOff | 1 | 2 | 3; $\C{// turn off implicit separator}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4046 +4046 @@
 \end{cfa}
 \begin{cfa}[belowskip=0pt]
-sout | sepEnable | 1 | 2 | 3; $\C{// turn on implicit separator}$
+sout | sepOn | 1 | 2 | 3; $\C{// turn on implicit separator}$
 \end{cfa}
 \begin{cfa}[mathescape=off,showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4053 +4053 @@
 
 \item
-\Indexc{sepOn}\index{manipulator!sepOn@©sepOn©} and \Indexc{sepOff}\index{manipulator!sepOff@©sepOff©} locally toggle printing the separator with respect to the next printed item, and then return to the global separator setting.
+\Indexc{sep}\index{manipulator!sep@©sep©} and \Indexc{nosep}\index{manipulator!nosep@©nosep©} locally toggle printing the separator with respect to the next printed item, and then return to the global separator setting.
 \begin{cfa}[belowskip=0pt]
-sout | 1 | sepOff | 2 | 3; $\C{// turn off implicit separator for the next item}$
+sout | 1 | nosep | 2 | 3; $\C{// turn off implicit separator for the next item}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4061 +4061 @@
 \end{cfa}
 \begin{cfa}[belowskip=0pt]
-sout | sepDisable | 1 | sepOn | 2 | 3; $\C{// turn on implicit separator for the next item}$
+sout | sepOff | 1 | sep | 2 | 3; $\C{// turn on implicit separator for the next item}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4068 +4068 @@
 The tuple separator also responses to being turned on and off.
 \begin{cfa}[belowskip=0pt]
-sout | t1 | sepOff | t2; $\C{// turn off implicit separator for the next item}$
+sout | t1 | nosep | t2; $\C{// turn off implicit separator for the next item}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
 1, 2, 34, 5, 6
 \end{cfa}
-©sepOn© \emph{cannot} be used to start/end a line with a separator because separators do not appear at the start/end of a line;
+©sep© \emph{cannot} be used to start/end a line with a separator because separators do not appear at the start/end of a line;
 use ©sep© to accomplish this functionality.
 \begin{cfa}[belowskip=0pt]
-sout | sepOn | 1 | 2 | 3 | sepOn; $\C{// sepOn does nothing at start/end of line}$
+sout | sep | 1 | 2 | 3 | sep; $\C{// sep does nothing at start/end of line}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4373 +4373 @@
         sout | t1 | t2 | " \"" | sepGetTuple( sout ) | "\"";
 
-        sout | sepDisable | 1 | 2 | 3;          // globally turn off implicit separator
-        sout | sepEnable | 1 | 2 | 3;           // globally turn on implicit separator
-
-        sout | 1 | sepOff | 2 | 3;                      // locally turn on implicit separator
-        sout | sepDisable | 1 | sepOn | 2 | 3; // globally turn off implicit separator
-        sout | sepEnable;
-        sout | t1 | sepOff | t2;                                // locally turn on/off implicit separator
-
-        sout | sepOn | 1 | 2 | 3 | sepOn ;      // sepOn does nothing at start/end of line
+        sout | sepOff | 1 | 2 | 3;              // globally turn off implicit separator
+        sout | sepOn | 1 | 2 | 3;               // globally turn on implicit separator
+
+        sout | 1 | nosep | 2 | 3;                       // locally turn on implicit separator
+        sout | sepOff | 1 | sep | 2 | 3; // globally turn off implicit separator
+        sout | sepOn;
+        sout | t1 | nosep | t2;                         // locally turn on/off implicit separator
+
+        sout | sep | 1 | 2 | 3 | sep ;  // sep does nothing at start/end of line
         sout | sep | 1 | 2 | 3 | sep ;          // use sep to print separator at start/end of line
 }