2024-03-16 16:25:48 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="generator" content="TempleOS V5.03">
<link rel="stylesheet" href="/style/templeos.css">
<script src="/script/templeos.js"></script>
<style type="text/css">
.c0F{color:#ffffff;background-color:#000000;}
.cF0{color:#000000;background-color:#ffffff;}
.cF1{color:#0000aa;background-color:#ffffff;}
.cF2{color:#00aa00;background-color:#ffffff;}
.cF3{color:#00aaaa;background-color:#ffffff;}
.cF4{color:#aa0000;background-color:#ffffff;}
.cF5{color:#aa00aa;background-color:#ffffff;}
.cF6{color:#aa5500;background-color:#ffffff;}
.cF7{color:#aaaaaa;background-color:#ffffff;}
.cF8{color:#555555;background-color:#ffffff;}
.cF9{color:#5555ff;background-color:#ffffff;}
.cFA{color:#55ff55;background-color:#ffffff;}
.cFB{color:#55ffff;background-color:#ffffff;}
.cFC{color:#ff5555;background-color:#ffffff;}
.cFD{color:#ff55ff;background-color:#ffffff;}
.cFE{color:#ffff55;background-color:#ffffff;}
.cFF{color:#ffffff;background-color:#ffffff;}
</style>
</head>
<body>
2024-03-23 13:40:50 +00:00
<pre style="font-family: courier, monospace; font-size: 10pt;">
2024-03-16 16:25:48 +00:00
<a name="l1"></a><span class=cF5> DolDoc Overview</span><span class=cF0>
<a name="l2"></a>
<a name="l3"></a>DolDoc is a TempleOS document type supported by </span><span class=cF4><u>DolDoc Routines</u></span><span class=cF0>. In a document,
<a name="l4"></a>commands are bracketed with '</span><span class=cF2>$</span><span class=cF0>'s. Use </span><span class=cF2><CTRL-l></span><span class=cF0> to experiment inserting a
<a name="l5"></a>command. Then, use </span><span class=cF2><CTRL-t></span><span class=cF0> to toggle to plain text to see it.
<a name="l6"></a>
<a name="l7"></a>Here is the grammar:
<a name="l8"></a>
2024-03-23 13:40:50 +00:00
<a name="l9"></a><DolDocCmd> := </span><span class=cF2>$</span><span class=cF0><</span><a href="/Wb/Adam/DolDoc/DocInit.HC#l9"><span class=cF4>TwoLetterCmd</span></a><span class=cF0>>[<FlagList>][</span><span class=cF2>,</span><span class=cF0><ArgList>]</span><span class=cF2>$</span><span class=cF0> | </span><span class=cF2>$</span><a href="/Wb/Kernel/KDefine.HC#l118"><span class=cF4>ColorName</span></a><span class=cF2>$</span><span class=cF0>
2024-03-16 16:25:48 +00:00
<a name="l10"></a>
2024-03-23 13:40:50 +00:00
<a name="l11"></a><FlagList> := </span><span class=cF2>+</span><span class=cF0>|</span><span class=cF2>-</span><span class=cF0> <</span><a href="/Wb/Adam/DolDoc/DocInit.HC#l13"><span class=cF4>FlagCode</span></a><span class=cF0>>[<FlagList>]
2024-03-16 16:25:48 +00:00
<a name="l12"></a>
2024-03-23 13:40:50 +00:00
<a name="l13"></a><ArgList> := <</span><a href="/Wb/Adam/DolDoc/DocInit.HC#l13"><span class=cF4>ArgCode</span></a><span class=cF0>></span><span class=cF2>=</span><span class=cF0><ArgExpression>[</span><span class=cF2>,</span><span class=cF0><ArgList>]
2024-03-16 16:25:48 +00:00
<a name="l14"></a>
<a name="l15"></a>
<a name="l16"></a>The format of DolDoc cmds is a two character code, +/-flags, a comma and args
<a name="l17"></a>separated by commas. Some commands have mandatory args. Optional args are
2024-03-23 13:40:50 +00:00
<a name="l18"></a>indicated with <</span><a href="/Wb/Adam/DolDoc/DocInit.HC#l13"><span class=cF4>ArgCode</span></a><span class=cF0>></span><span class=cF2>=</span><span class=cF0>. A </span><a href="/Wb/Kernel/KDefine.HC#l118"><span class=cF4>ColorName</span></a><span class=cF0> bracked by dollars, will change the
2024-03-16 16:25:48 +00:00
<a name="l19"></a>foreground color.
<a name="l20"></a>
2024-03-23 13:40:50 +00:00
<a name="l21"></a>See </span><a href="/Wb/Doc/Widget.DD.HTML#l1"><span class=cF4>::/Doc/Widget.DD</span></a><span class=cF0>, </span><a href="/Wb/Demo/DolDoc/DemoDoc.DD.HTML#l1"><span class=cF4>::/Demo/DolDoc/DemoDoc.DD</span></a><span class=cF0>, and </span><span class=cF4>
<a name="l22"></a></span><a href="/Wb/Demo/ToHtmlToTXTDemo/ToHtml.HC#l1"><span class=cF4>::/Demo/ToHtmlToTXTDemo/ToHtml.HC</span></a><span class=cF0>.
2024-03-16 16:25:48 +00:00
<a name="l23"></a>
2024-03-23 13:40:50 +00:00
<a name="l24"></a><</span><a href="/Wb/Adam/DolDoc/DocInit.HC#l9"><span class=cF4>TwoLetterCmd</span></a><span class=cF0>> See </span><a href="/Wb/Kernel/KernelA.HH#l904"><span class=cF4>Type Defines</span></a><span class=cF0> and </span><a href="/Wb/Adam/DolDoc/DocPlain.HC#l217"><span class=cF4>PrsDollarCmd</span></a><span class=cF0>().</span><span class=cF5>
2024-03-16 16:25:48 +00:00
<a name="l25"></a><u>+] TX Text
<a name="l26"></a>+] CR Hard New Line
<a name="l27"></a>+] SR Soft New Line
<a name="l28"></a>+] CU Cursor pos
<a name="l29"></a>+] TB Tab
<a name="l30"></a>+] CL Clear
<a name="l31"></a>+] PB Page Break
<a name="l32"></a>+] PL Page Length
<a name="l33"></a>+] LM Left Margin
<a name="l34"></a>+] RM Right Margin
<a name="l35"></a>+] HD Header
<a name="l36"></a>+] FO Footer
<a name="l37"></a>+] ID Indent +/- num
<a name="l38"></a>+] Text Colors
<a name="l39"></a>+] PT User Prompt
<a name="l40"></a>+] WW Word Wrap
<a name="l41"></a>+] UL Underline
<a name="l42"></a>+] IV Invert
<a name="l43"></a>+] BK Blink
<a name="l44"></a>+] SX Shift X pos
<a name="l45"></a>+] SY Shift Y pos
<a name="l46"></a>+] CM Cursor Movement
<a name="l47"></a>+] AN Anchor
<a name="l48"></a>+] LK Link
<a name="l49"></a>+] BT Bttn
<a name="l50"></a>+] DA Data
<a name="l51"></a>+] CB Check Box
<a name="l52"></a>+] LS List Widget
<a name="l53"></a>+] MA Macro
<a name="l54"></a>+] MU Menu Value
<a name="l55"></a>+] HX Hex Edit
<a name="l56"></a>+] TR Tree Widget
<a name="l57"></a>+] SP Sprite
<a name="l58"></a>+] IB Insert Binary
<a name="l59"></a>+] IS Insert Binary Size
<a name="l60"></a>+] SO Song
<a name="l61"></a>+] HL Highlighting
<a name="l62"></a>+] HC html
<a name="l63"></a>+] ER Error</span><span class=cF0>
<a name="l64"></a>
2024-03-23 13:40:50 +00:00
<a name="l65"></a></u><</span><a href="/Wb/Adam/DolDoc/DocInit.HC#l13"><span class=cF4>FlagCode</span></a><span class=cF0>> See </span><a href="/Wb/Kernel/KernelA.HH#l1075"><span class=cF4>Flag Defines</span></a><span class=cF0> and </span><a href="/Wb/Doc/Widget.DD.HTML#l1"><span class=cF4>Simple Flags</span></a><span class=cF0>.</span><span class=cF5>
2024-03-16 16:25:48 +00:00
<a name="l66"></a><u>+] +H Hold
<a name="l67"></a>+] +L Link
<a name="l68"></a>+] +TR Tree
<a name="l69"></a>+] +LS List
<a name="l70"></a>+] +PU PopUp
<a name="l71"></a>+] +C Collapsed
<a name="l72"></a>+] +X <ESC> (Exit)
<a name="l73"></a>+] +Q <SHIFT-ESC> (Abort Quit)
<a name="l74"></a>+] +Z Zero
<a name="l75"></a>+] +RD Refresh Data
<a name="l76"></a>+] +UD Update Data
<a name="l77"></a>+] +TC Tag CallBack
<a name="l78"></a>+] +LC Left CallBack
<a name="l79"></a>+] +RC Right CallBack</span><span class=cF0>
<a name="l80"></a>
2024-03-23 13:40:50 +00:00
<a name="l81"></a></u><</span><a href="/Wb/Adam/DolDoc/DocInit.HC#l13"><span class=cF4>ArgCode</span></a><span class=cF0>> See </span><a href="/Wb/Kernel/KernelA.HH#l1057"><span class=cF4>Arg Defines</span></a><span class=cF0>.</span><span class=cF5>
2024-03-16 16:25:48 +00:00
<a name="l82"></a><u>+] T="" Tag Str
<a name="l83"></a>+] LEN="" Field Length
<a name="l84"></a>+] A="" Auxilliary Str
<a name="l85"></a>+] D="" Define Str
<a name="l86"></a>+] HTML=""
<a name="l87"></a>+] LE=<Exp> Left Expression
<a name="l88"></a>+] LM="" Left Macro Str
<a name="l89"></a>+] RE=<Exp> Right Expression
<a name="l90"></a>+] RM="" Right Macro Str
<a name="l91"></a>+] BI=<Exp> Bin Number
<a name="l92"></a>+] BP="" Bin Ptr
<a name="l93"></a>+] RT=<raw_data_type>
<a name="l94"></a>+] SX=<Exp> Shift X
<a name="l95"></a>+] SY=<Exp> Shift Y
<a name="l96"></a>+] SCX=<Exp> Scroll X
<a name="l97"></a>+] U=<Exp> User Data</span><span class=cF0>
<a name="l98"></a>
<a name="l99"></a></u></span><span class=cF5>EXAMPLES:
<a name="l100"></a>
<a name="l101"></a></span><span class=cF0><CTRL-t> to see how the following were done.
<a name="l102"></a><u>Underlined</u> </span><span class=c0F>Inverted</span><span class=cF0> <blink>Blinking</blink> super sub
<a name="l103"></a>This is a big long scrolling msg.
<a name="l104"></a>
<a name="l105"></a></span><span class=cF5>Cursor Movements:</span><span class=cF0>
<a name="l106"></a>
<a name="l107"></a>
<a name="l108"></a>
<a name="l109"></a> Cursor moved 3 rows down and to 3rd column from left.
<a name="l110"></a>
<a name="l111"></a>
<a name="l112"></a>
<a name="l113"></a> Note mandatory comma after flags
<a name="l114"></a>
<a name="l115"></a>The following may be changed to modes instead of attr with flags.
<a name="l116"></a>
<a name="l117"></a> This is centered
<a name="l118"></a>
<a name="l119"></a> This is right justified
</span></pre></body>
</html>
