mirror of
https://github.com/Zeal-Operating-System/ZealOS.git
synced 2024-12-28 00:06:35 +00:00
146 lines
9.4 KiB
HTML
Executable file
146 lines
9.4 KiB
HTML
Executable file
<!DOCTYPE HTML>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=US-ASCII">
|
|
<meta name="generator" content="ZealOS V1.01">
|
|
<style type="text/css">
|
|
body {background-color:#fef1f0;}
|
|
.c0F{color:#fef1f0;background-color:#000000;}
|
|
.cF0{color:#000000;background-color:#fef1f0;}
|
|
.cF1{color:#0148a4;background-color:#fef1f0;}
|
|
.cF2{color:#3b7901;background-color:#fef1f0;}
|
|
.cF3{color:#057c7e;background-color:#fef1f0;}
|
|
.cF4{color:#bb2020;background-color:#fef1f0;}
|
|
.cF5{color:#9e42ae;background-color:#fef1f0;}
|
|
.cF6{color:#b57901;background-color:#fef1f0;}
|
|
.cF7{color:#b2b6af;background-color:#fef1f0;}
|
|
.cF8{color:#555753;background-color:#fef1f0;}
|
|
.cF9{color:#678fbb;background-color:#fef1f0;}
|
|
.cFA{color:#82bc49;background-color:#fef1f0;}
|
|
.cFB{color:#0097a2;background-color:#fef1f0;}
|
|
.cFC{color:#e26a6a;background-color:#fef1f0;}
|
|
.cFD{color:#c671bc;background-color:#fef1f0;}
|
|
.cFE{color:#c7ab00;background-color:#fef1f0;}
|
|
.cFF{color:#fef1f0;background-color:#fef1f0;}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<pre style="font-family:monospace;font-size:12pt">
|
|
<a name="l1"></a><span class=cF5> DolDoc Overview</span><span class=cF0>
|
|
<a name="l2"></a>
|
|
<a name="l3"></a>DolDoc is a ZealOS document type supported by </span><span class=cF4><u>DolDoc Routines</u></span><span class=cF0>. In a document, commands are bracketed with '</span><span class=cF2>$</span><span class=cF0>'s. Use </span><span class=cF2><CTRL-
|
|
<a name="l4"></a>l></span><span class=cF0> to experiment inserting a command. Then, use </span><span class=cF2><CTRL-t></span><span class=cF0> to toggle to plain text to see it.
|
|
<a name="l5"></a>
|
|
<a name="l6"></a>Here is the grammar:
|
|
<a name="l7"></a>
|
|
<a name="l8"></a><DolDocCmd> := </span><span class=cF2>$</span><span class=cF0><</span><a href="https://zeal-operating-system.github.io/ZealOS/System/DolDoc/DocInit.CC.html#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="https://zeal-operating-system.github.io/ZealOS/Kernel/KDefine.CC.html#l248"><span class=cF4>ColorName</span></a><span class=cF2>$</span><span class=cF0>
|
|
<a name="l9"></a>
|
|
<a name="l10"></a><FlagList> := </span><span class=cF2>+</span><span class=cF0>|</span><span class=cF2>-</span><span class=cF0> <</span><a href="https://zeal-operating-system.github.io/ZealOS/System/DolDoc/DocInit.CC.html#l14"><span class=cF4>FlagCode</span></a><span class=cF0>>[<FlagList>]
|
|
<a name="l11"></a>
|
|
<a name="l12"></a><ArgList> := <</span><a href="https://zeal-operating-system.github.io/ZealOS/System/DolDoc/DocInit.CC.html#l14"><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>]
|
|
<a name="l13"></a>
|
|
<a name="l14"></a>
|
|
<a name="l15"></a>The format of DolDoc cmds is a two character code, +/-flags, a comma and args separated by commas. Some commands have
|
|
<a name="l16"></a>mandatory args. Optional args are indicated with <</span><a href="https://zeal-operating-system.github.io/ZealOS/System/DolDoc/DocInit.CC.html#l14"><span class=cF4>ArgCode</span></a><span class=cF0>></span><span class=cF2>=</span><span class=cF0>. A </span><a href="https://zeal-operating-system.github.io/ZealOS/Kernel/KDefine.CC.html#l248"><span class=cF4>ColorName</span></a><span class=cF0> bracked by dollars, will change the foreground
|
|
<a name="l17"></a>color.
|
|
<a name="l18"></a>
|
|
<a name="l19"></a>See </span><a href="https://zeal-operating-system.github.io/ZealOS/Doc/Widget.DD.html#l1"><span class=cF4>::/Doc/Widget.DD</span></a><span class=cF0>, </span><a href="https://zeal-operating-system.github.io/ZealOS/Demo/DolDoc/DemoDoc.DD.html#l1"><span class=cF4>::/Demo/DolDoc/DemoDoc.DD</span></a><span class=cF0>, and </span><a href="https://zeal-operating-system.github.io/ZealOS/Demo/ToHtmlToTXTDemo/ToHtml.CC.html#l1"><span class=cF4>::/Demo/ToHtmlToTXTDemo/ToHtml.CC</span></a><span class=cF0>.
|
|
<a name="l20"></a>
|
|
<a name="l21"></a><</span><a href="https://zeal-operating-system.github.io/ZealOS/System/DolDoc/DocInit.CC.html#l9"><span class=cF4>TwoLetterCmd</span></a><span class=cF0>> See </span><a href="https://zeal-operating-system.github.io/ZealOS/Kernel/KernelA.HH.html#l1041"><span class=cF4>Type Defines</span></a><span class=cF0> and </span><a href="https://zeal-operating-system.github.io/ZealOS/System/DolDoc/DocPlain.CC.html#l272"><span class=cF4>ParseDollarCmd</span></a><span class=cF0>().</span><span class=cF5>
|
|
<a name="l22"></a><u>+] TX Text
|
|
<a name="l23"></a>+] CR Hard New Line
|
|
<a name="l24"></a>+] SR Soft New Line
|
|
<a name="l25"></a>+] CU Cursor pos
|
|
<a name="l26"></a>+] TB Tab
|
|
<a name="l27"></a>+] CL Clear
|
|
<a name="l28"></a>+] PB Page Break
|
|
<a name="l29"></a>+] PL Page Length
|
|
<a name="l30"></a>+] LM Left Margin
|
|
<a name="l31"></a>+] RM Right Margin
|
|
<a name="l32"></a>+] HD Header
|
|
<a name="l33"></a>+] FO Footer
|
|
<a name="l34"></a>+] ID Indent +/- num
|
|
<a name="l35"></a>+] Text Colors
|
|
<a name="l36"></a>+] PT User Prompt
|
|
<a name="l37"></a>+] WW Word Wrap
|
|
<a name="l38"></a>+] UL Underline
|
|
<a name="l39"></a>+] IV Invert
|
|
<a name="l40"></a>+] BK Blink
|
|
<a name="l41"></a>+] SX Shift X pos
|
|
<a name="l42"></a>+] SY Shift Y pos
|
|
<a name="l43"></a>+] CM Cursor Movement
|
|
<a name="l44"></a>+] AN Anchor
|
|
<a name="l45"></a>+] LK Link
|
|
<a name="l46"></a>+] BT Bttn
|
|
<a name="l47"></a>+] DA Data
|
|
<a name="l48"></a>+] CB Check Box
|
|
<a name="l49"></a>+] LS List Widget
|
|
<a name="l50"></a>+] MA Macro
|
|
<a name="l51"></a>+] MU Menu Value
|
|
<a name="l52"></a>+] HX Hex Edit
|
|
<a name="l53"></a>+] TR Tree Widget
|
|
<a name="l54"></a>+] SP Sprite
|
|
<a name="l55"></a>+] IB Insert Binary
|
|
<a name="l56"></a>+] IS Insert Binary Size
|
|
<a name="l57"></a>+] SO Song
|
|
<a name="l58"></a>+] HL Highlighting
|
|
<a name="l59"></a>+] HC html
|
|
<a name="l60"></a>+] ER Error</span><span class=cF0>
|
|
<a name="l61"></a>
|
|
<a name="l62"></a></u><</span><a href="https://zeal-operating-system.github.io/ZealOS/System/DolDoc/DocInit.CC.html#l14"><span class=cF4>FlagCode</span></a><span class=cF0>> See </span><a href="https://zeal-operating-system.github.io/ZealOS/Kernel/KernelA.HH.html#l1209"><span class=cF4>Flag Defines</span></a><span class=cF0> and </span><a href="https://zeal-operating-system.github.io/ZealOS/Doc/Widget.DD.html#l1"><span class=cF4>Simple Flags</span></a><span class=cF0>.</span><span class=cF5>
|
|
<a name="l63"></a><u>+] +H Hold
|
|
<a name="l64"></a>+] +L Link
|
|
<a name="l65"></a>+] +TR Tree
|
|
<a name="l66"></a>+] +LS List
|
|
<a name="l67"></a>+] +PU PopUp
|
|
<a name="l68"></a>+] +C Collapsed
|
|
<a name="l69"></a>+] +X <ESC> (Exit)
|
|
<a name="l70"></a>+] +Q <SHIFT-ESC> (Abort Quit)
|
|
<a name="l71"></a>+] +Z Zero
|
|
<a name="l72"></a>+] +RD Refresh Data
|
|
<a name="l73"></a>+] +UD Update Data
|
|
<a name="l74"></a>+] +TC Tag CallBack
|
|
<a name="l75"></a>+] +LC Left CallBack
|
|
<a name="l76"></a>+] +RC Right CallBack</span><span class=cF0>
|
|
<a name="l77"></a>
|
|
<a name="l78"></a></u><</span><a href="https://zeal-operating-system.github.io/ZealOS/System/DolDoc/DocInit.CC.html#l14"><span class=cF4>ArgCode</span></a><span class=cF0>> See </span><a href="https://zeal-operating-system.github.io/ZealOS/Kernel/KernelA.HH.html#l1191"><span class=cF4>Arg Defines</span></a><span class=cF0>.</span><span class=cF5>
|
|
<a name="l79"></a><u>+] T="" Tag Str
|
|
<a name="l80"></a>+] LEN="" Field Length
|
|
<a name="l81"></a>+] A="" Auxilliary Str
|
|
<a name="l82"></a>+] D="" Define Str
|
|
<a name="l83"></a>+] HTML=""
|
|
<a name="l84"></a>+] LE=<Exp> Left Expression
|
|
<a name="l85"></a>+] LM="" Left Macro Str
|
|
<a name="l86"></a>+] RE=<Exp> Right Expression
|
|
<a name="l87"></a>+] RM="" Right Macro Str
|
|
<a name="l88"></a>+] BI=<Exp> Bin Number
|
|
<a name="l89"></a>+] BP="" Bin Ptr
|
|
<a name="l90"></a>+] RT=<raw_data_type>
|
|
<a name="l91"></a>+] SX=<Exp> Shift X
|
|
<a name="l92"></a>+] SY=<Exp> Shift Y
|
|
<a name="l93"></a>+] SCX=<Exp> Scroll X
|
|
<a name="l94"></a>+] U=<Exp> User Data</span><span class=cF0>
|
|
<a name="l95"></a>
|
|
<a name="l96"></a></u></span><span class=cF5>EXAMPLES:
|
|
<a name="l97"></a>
|
|
<a name="l98"></a></span><span class=cF0><CTRL-t> to see how the following were done.
|
|
<a name="l99"></a><u>Underlined</u> </span><span class=c0F>Inverted</span><span class=cF0> <blink>Blinking</blink> super sub
|
|
<a name="l100"></a>This is a big long scrolling message.
|
|
<a name="l101"></a>
|
|
<a name="l102"></a></span><span class=cF5>Cursor Movements:</span><span class=cF0>
|
|
<a name="l103"></a>
|
|
<a name="l104"></a>
|
|
<a name="l105"></a>
|
|
<a name="l106"></a> Cursor moved 3 rows down and to 3rd column from left.
|
|
<a name="l107"></a>
|
|
<a name="l108"></a>
|
|
<a name="l109"></a>
|
|
<a name="l110"></a> Note mandatory comma after flags
|
|
<a name="l111"></a>
|
|
<a name="l112"></a>The following may be changed to modes instead of attr with flags.
|
|
<a name="l113"></a>
|
|
<a name="l114"></a> This is centered
|
|
<a name="l115"></a>
|
|
<a name="l116"></a> This is right justified
|
|
</span></pre></body>
|
|
</html>
|