Changeset 795500c3 for doc/user

Timestamp:

Jun 29, 2023, 9:58:42 PM (11 months ago)

Author:

Peter A. Buhr <pabuhr@…>

Branches:

master

Children:

48ee593

Parents:

af5cfad6

Message:

update documentation for stream input and output

File:

• doc/user/user.tex (modified) (12 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 : Thu Jun 29 11:53:10 2023
-%% Update Count     : 5523
+%% Last Modified On : Thu Jun 29 21:52:51 2023
+%% Update Count     : 5533
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -3991 +3991 @@
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt]
-1®, $\LstStringStyle{\textdollar}$®2®, $\LstStringStyle{\textdollar}$®3 ®", $\LstStringStyle{\textdollar}$"®
+1®, $\color{red}\LstStringStyle{\textdollar}$®2®, $\color{red}\LstStringStyle{\textdollar}$®3 ®", $\color{red}\LstStringStyle{\textdollar}$"®
 \end{cfa}
 \begin{cfa}[belowskip=0pt]
@@ -4040 +4040 @@
 \Indexc{sepOff}\index{manipulator!sepOff@©sepOff©} and \Indexc{sepOn}\index{manipulator!sepOn@©sepOn©} globally toggle printing the separator.
 \begin{cfa}[belowskip=0pt]
-sout | sepOff | 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 | sepOn | 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]
@@ -4055 +4055 @@
 \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 | nosep | 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 | sepOff | 1 | sep | 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 | nosep | 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]
@@ -4076 +4076 @@
 use ©sep© to accomplish this functionality.
 \begin{cfa}[belowskip=0pt]
-sout | sep | 1 | 2 | 3 | sep; $\C{// sep 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]
@@ -4082 +4082 @@
 \end{cfa}
 \begin{cfa}[belowskip=0pt]
-sout | sep | 1 | 2 | 3 | sep ; $\C{// use sep to print separator at start/end of line}$
+sout | ®sepVal® | 1 | 2 | 3 | ®sepVal® ; $\C{// use sepVal to print separator at start/end of line}$
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
@@ -4116 +4116 @@
 \Indexc{nl}\index{manipulator!nl@©nl©} inserts a newline.
 \begin{cfa}
-sout | nl; $\C{// only print newline}$
+sout | ®nl®; $\C{// only print newline}$
 sout | 2; $\C{// implicit newline}$
-sout | 3 | nl | 4 | nl; $\C{// terminating nl merged with implicit newline}$
-sout | 5 | nl | nl; $\C{// again terminating nl merged with implicit newline}$
+sout | 3 | ®nl® | 4 | ®nl®; $\C{// terminating nl merged with implicit newline}$
+sout | 5 | ®nl® | ®nl®; $\C{// again terminating nl merged with implicit newline}$
 sout | 6; $\C{// implicit newline}$
 
@@ -4286 +4286 @@
 For the C-string type, precision is the maximum number of printed characters, so the string is truncated if it exceeds the maximum.
 \begin{cfa}[belowskip=0pt]
-sout | wd( 6,8, "abcd" ) | wd( 6,8, "abcdefghijk" ) | wd( 6,3, "abcd" );
+sout | wd( 6,8, "abcd" ) | wd( 6,8, "abcdefghijk" ) | wd( 6,3, "abcd" ) | ®wd( 10, "" )® | 'X';
 \end{cfa}
 \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt]
-  abcd abcdefgh    abc
-\end{cfa}
+  abcd abcdefgh    abc®          ®X
+\end{cfa}
+Note, printing the null string with minimum width L pads with L spaces.
 
 \item
@@ -4692 +4693 @@
         sout  | i | j | k | x | y | s;
 }
-
+\end{cfa}
+\begin{cfa}[showspaces=true]
 3 0x5          7 1.234568e+07 987.654n abc
 3 0x5          7 1.234568e+07 987.654n abc