From d49a8ba7ed28ddde395aa72ab5ed8f6482e96efd Mon Sep 17 00:00:00 2001 From: Thomas Walker Lynch Date: Tue, 10 Mar 2026 12:23:25 +0000 Subject: [PATCH] rename style doc --- docs.tar | Bin 30720 -> 0 bytes document/style_manual.html | 656 ++++++++++++++++++------------------- 2 files changed, 323 insertions(+), 333 deletions(-) delete mode 100644 docs.tar diff --git a/docs.tar b/docs.tar deleted file mode 100644 index dabb4ed3b470824ee13e6da1773e8c74cf29b292..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 30720 zcmeHQ>2e!KlGblMMGZH?CTB>1hmH-KzSTc{r&yn z)nIs@jr8!lte8brZ(7aL2Os;-KK^;KzyAP#96ddJ9R4X^JvusgaPaux@!{jcM~@#J zJlH>cboAuW1GWFL6Mo2hby-D)QV#~xY!;P6PmS&v_kG`e{&({G@gKf@bw2oy%V&x# zK7Dx1KU5mcCnsBazIFOgspF}RM*IOk&U6*2cp4R@u1>ao8hp3+@A3@3s*)goX{y3XgWp9#YlT=4} zQug9(){o2b@XzCDmZXc5msyql={lO1fBMVi7o()i(`a#0-bVSBDs+0XRaT2sms71P zw=}aHRTlBdRozSA*W_0k(I(R^j`{eMiA#zF>#E8tg?ymBb*L&;lgHM?xHBKTs;Ft7%r8Y#HfO zucP#hF4XhIJf3bfPmQ8VpKKlOA3oXJKib=W9DF6?oowC97Pb9XU6e^SSC4iq*|4C# zThZymV2y)U=PISuIN3TNrSK3wY95&$oW8pGn~p2>w(O~kIW%k@YxOdNaf#EYstZT~ z9&$tG?kA;QYw)nt1th1MYIU0xBlTq_gMF#SS)r1uR1-bdMU<*%^GTYNQ#I4kJef~= z>h)C56(l0A%Mu?b&?Uk+QKgbn&G1lOV|qPOWtQr6fv<|Jo=jDwMtYpg@kKJPbTN)% zy{qcdtN|a)3~TViX<~O{NW)KhZX12cHg==3rw<0w6kO3)8Pm(Py-c%$|DclA7$Np{uS zs7Rul_8{dvdZUN&J%fCoW;an9PX5#7<+H2d^~Ws-BM^%W+odW~^Z_R+TCHl2&OpNkCHw18j%LMxH?{!6KE7Wy)r%7N;${?%Lvc zYiBW53pp5NRkNah{5@C_MLQa)X%?$_G}C1c5iDVCs%bJ0He0G~-JA4wn^6WY{_*#- zqG*QNp~k7p1?9 zI?)5K&qgCKF^2h$pi70SAjYaR?@(=UijbzW=na*@i>BGI%F`M;-BT}NSPD@-^GVq| z<}xg~8{sml;y3Zf;V5s2puU0`C}4py$Vwhn(`79Q-W<2z94D#1|0PIo)tXSOQW7he zEM3r)RC)#yb+t2?H_qyLdyIKKyTR^3C7o)zVyyv;ZaGrG#GGfdSpw|D8zV)7a-*R)u!S@seqA`i z`14%fDtH$#NGi}CP2k@={I9hv zeF3^9_bv6+9OgmR3VHX-Emf4~X<|8?&C`YDZzg-lYM#egS*Z`(jT&!Hw%_gSsE^pq zHC(VtT~{z=>Iz44M|m#BR1*l2Xsn81XU9+u$RR!!rimbm4ne(2j<&1bXq{7smL8*+ zVwdWs;2E%5GQpmA>f}W2@8H;iKQ&)3TNjO_x1_3TO|PpWi7Prrw^oc`4PcJ~O)-ui zR@Jp@joq%I8!mhK0WggkS(*b{*jX;1f$&yhXYlYT+%<%w)L7{8tTj^G0^a4;i*rBB zig>Ea%D4tATzcA~zyUv&XaE6F-vmOxllbjZm)Tnx{~ryF%Q}SJAAajjQXm4}f&CCf z;J*0(2r+*v{yzc&u!;Xam9_8n{^ySWZKy+k!OKlM@Y#g_66dw8kNfD3@c(KMg!K1E z`}Z+nZGi8cZKcivFPdQqy~7I8BThCP(-MU6G(OD>;)fMZYV1lrkuVR(pN1_T<2XbJ z+M^hh`sW%>SGw5k42|*N`V{ydjvp5b05?+lT{O#6xN&8j=NaO}Tdk%M@PSA*-f{&) zZ)U++g>Ss`-%|tlg8o+k3Uvy{7VaUo11Hk?dK{qf=HWAzN=NZj#^jLnD4S8HJ{mRq z<{ob}y)D2E7^xK~I!7s>>qQkTB!RP*jJYku16W*C;Y0+eK^F=ehdVBlBse!2#F-^w z0dV?-xLlfqEad_*)=Z5HYz@H4n_UHmo$;6j9pGUH&y{fL)Eoh+&=o^5OziULmht#p zGaA^1Cy;SH@GG$jnh>-ws*qhZ-j_GH(HBqq5i=fwtF$3%u zzwB<)y$Ht*Kc36e_i-DTmf@_>!;DKLz=picrkZ)r&;66XS&eW|1$|CrbQJKvN9APa6aB(WW zLb3m>E_E@D0N$>P)L&0CE+f<{8<2sJZgdC*f()-|lzEy3qpTtqvV~>masXZx0QJl+ zv1}u&hGve-6a`F%e04Zs?xCYmFO%pkL%fXH5p+*Q2`@Hj9`t@f2t_ zv*Ja=ax%j#{I*CcSYYBf(;A`%^bjP*BCx4Zv;f46Q=5vb&MtOfh^I6io+Ry=15QH# zMzAghAkDHA=7$G$WI;zq53%eyP9TK%Z=wkZ2dVd?uUNjA18OE=?7Hi1Q{4PF6brb`P-z(<^=d~3WG8{hiRidENu@X8W-k{AVb1jlTE<~IH5d(Du)+N zP&v^i&{T59V%Kz?IE_F(bThd4;H2Zb*gPB}OpkM&rqN93&u5A_)E>twHeg=`z5y*G z!O1kbT+>WdJ6p#WN{DAwMq; z@V?Agiw9tV$nM{l@V~4JM&~VfIdIAbICgLX^5o{hjglgsJgGG@d(mVLNI!{9$O=HX zMzHF>MWmXHjT@x|FMcP!8vX#6Bq9z2159CvC<;26(bmvVp;qnVO zww7d*2QK9kQ${KBhvmux3kkLZgvwUN>sf2pNVy&K4hVKsh)9q&aG@B-{*Erz^JoEp zA1{U3Q|~N1ljz?#K?E9jv|^*#d~$l>yc<-Pm`@m>GDjm637>2o{L7C^00K_{&Wm^! zCeX2i88TJb1o4FVY$cHY5^hO~`yKu_hJNHN`9I0nT0nYw_Wy4_xkcH*Hxwpb*NsLDk-D6&o5jx1Po0}YV%Xe5EE?hOu+)-U0&?8R&I+`?6U}EAr}=(Q>YZ- zAg-i<=q~LpLi7TU$WQtmw1G@3+k+qXo3)}0=Mo`zcNn3LS0sdiL$MUYA(O~k!{H34 z<#4zK0yvB0n9sG^W1**hWX@X32{aC5fdDWWf&{$a&fq3gwf z)(26(FS*(kbOq}o-@Py!xX#<%#<&_dJbIe}@MC_4=L5{cL`np4SR0|23J989p6(fJ zF0i{LVR+Ot?p0qsgA-AjU+%KCk7#R~LO)yQl)>6>OA+JV8%WKKlrkcoXvvHBroPc} zL}aDq)CD;YB$G_lVN(wmlpXF+4a&vr1}GQdKn)lkW-a+8z{$Ex33P~{5%Ct(zm6hQ zveE#1(;>p{Sz;V8yB7FbG@It_pqkN+=P-Gxj@#jFf1ZC#%m!m4ik;~Rv&)4;}5uK0a#h8yhsNYh`wcnusD+rwe_h=i)fJX^}Fo;gREfdqDomQR3s%|pHae~q^ zyt7=f^Jxuc-iJIqy|fid#1*fl3xh$*M+J**-_GvXL}B+viA_|)@U%t+A7YksK*@0U zB@p2HnxGf;7W6iow@71GumP9Qv*GUWvK2DAFl>E@D3u8B6$N5(XczM}0V|@vAaYyR zL{|i{S`*#4x`8$gdak841U!8-tJEtzUfd=nun|ZY-}R2TFQahfjD}%SbkYzxWKENn zBxn8-y^WT6G6rl@0y&D`aJN2=Z!@RUODWNzq$Ie&_ae5?*`c#GyoSrq@QO7TIYNN3 z=~86fN6<{zMDbxap@i|xnBBI*m4O6;++U@=&(=G+ir%J6WYgWZ>Fz_e8xYk1YGRTD zFk%9HZMyq5-F+X_tGMazGZlVo-O6i+=Qg<9rn~P$V&(sj&-VJ!2$xd;@|8x()*V2X zMaEk^h7cUnP4JOLfa~#}gZ;y!qYnP_1nq#E`oG^o-aa?}V`ZjO_VfzrM+6DT>i%=P z|B(Kz^Ur?254;!yc)4pTI=2Mbx~A=hZ+*v%7l^p9Ejo8;0DA-dIQ+1A%rd;G46>~^k;@%Bj z2VfHGEViGZa1x7gVVsnVh7gi`fbRP%^h52T>H#S|76q`4C~DU~@kuk6g-Z~0vYexQ zgCtnR`(tE>GcC80xRwpxDidQJdXIe+rZ_nJ&d67!|5lMR#W5zmPz8mEn zB;kEfEbVw9oi?kh2%K<@5+hrT>_Jl$yGdaM9V*)*go?937}v|V*T=+InHL*c?)Fl0~#Crpqf zjEQ1fTjLVPg4W=7R`ihyC}R=LWFMoI0aR6@$A>K_HE(WWolI6zNSsczYmfkKxYB~l zsG4@GI<2gzpkduKX#s|FjHiAR(L^>jV;L*dPf4L}V@dc9LA>>S(d86Fq0t7$cH(+^ z&SW1*s^fkdpg=RJb#NzU-+pdu5h1%CrHmpw<}kQ z%98~52~aiLbC|c+PC&ADhlimp>lv*#RHOhU0O#gqd?txuZ>#y zBGrHywoEPPxohvLQ&oB(c+^kWn;H~)Z9{|KicrGtCtO*D0R-2VqPT`_ifxf{CL7yp zd-tF;IFClsOplH{HaOsZDRhz&Au|O;Owc ziZMk+BJVihi+)2r9I^;)8d5epYVE@^^KNrz{gF_LY3bTdi8&S^m$;(pjoHrkNwrRE z=_z){bZ;}lF~@o1c7Q;}oZ9;i*~BaUbGLT7T?*Z?tEgp#Z$ZIco_nze(;=_hh2cHW#UB< zj8G5mlvD{)td_KGTZbMbX_pdSl+nXt@=T8M_P&L+nnT%A*%Nh= zM{Rg(qF8e~E!ga@Rbp5Ikrqi1H>veb z2LU@g^+)_CQ~z~?$7E>AUNmRF!*fFS!n%pe@ZMF8OKEtf7|9XG26S<5AUNP@8@N~< z|EINQ?+a^;X|R`f4hw@T2AW#@*TyM!Cf;_-=p`HmQkF}w-x zBv9_J@-&y2IFPHQKAD4mH32`OOK1y2e`v4ND6L*~z|IvEBOi+fP$+Alb*miEvmEgY z;zVxzXSDVUstsjD)d%jU0lWpfVKAFmB2)}&5MJDYi@)ihGiHZ0ygHc>qTpiMVKS{u zco4e|2*KlVz;r&QiV+##9f8rR1UOiLe{nm=(GZX+(FB6#IH>O`^w&W$4_%nnLY4fd zJ`VPuP%?Dkf2BM*%i1(7E(hqQEsHfZfMKvTxi7J4st1M(q!;L(0fGS873$*KXZRD> z?(Uk44~u%vzf-}=2JaT*6$~Jqxn?aejIH?6tqyVWmE|GMg;_>G=q{Fsm%zD5X)wh+ zEq2l($AExoAAu)A6a)?Nq!JlI=S*NpOe;cD+v1t<(F8^ID sn@gL23wM7r$A$tM3T!B_p}>X$8wzYFu%W<)0vif!D6pZxzbFO%54h{BM*si- diff --git a/document/style_manual.html b/document/style_manual.html index cf6e7f2..ebf70b4 100644 --- a/document/style_manual.html +++ b/document/style_manual.html @@ -1,338 +1,328 @@ - - - RT Style System: Reference Manual - - - - - - - - - - - - - - - - - - - - - - - -

Table of Custom Tags

- -

Style Tag Reference

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TagDescription
<RT-article>Article container.
<RT-title> - Title block and metadata. -
<RT-TOC>Generates TOC.
<RT-term>Conventional term.
<RT-term-em>Forces emphasis for a term even after first occurrence.
<RT-neologism>Project specific term.
<RT-neologism-em>Forces emphasis for a neologism even after first occurrence.
<RT-code>Code span or code block.
<RT-math>Inline or block math.
<RT-page>Automatically inserted pagination tag.
- -

Architecture Overview

-

- The RT Style System is a client-side, JavaScript-driven publishing framework designed to turn raw HTML into high-readability technical documentation. Unlike standard CSS frameworks, RT uses JavaScript to handle complex layout tasks like ink-ratio balancing and dynamic pagination. -

- -

The Orchestrator

-

- The core of the system is style_orchestrator.js. It is placed at the bottom of the HTML <body>. Its job is to: -

-
    -
  1. Detect which modules are already loaded.
    2. -
  2. Load missing modules (defaulting to Dark Theme if none is specified).
    3. -
  3. Execute the Semantics Phase (styling tags).
    4. -
  4. Wait for MathJax (if present).
    5. -
  5. Execute the Layout Phase (pagination, page rendering).
    6. -
  6. Reveal the document.
    7. -
- -

Semantic Tags

-

- The system relies on a specific set of custom tags in the RT- namespace to separate structure from presentation. -

- -

Terminology

- -

Conventional Terms

-

- Use <RT-term> for standard, industry accepted technical terms. The system decorates only the first occurrence of each unique term so that the first appearance functions as a definition point, and later appearances do not overload the page with styling. -

- - -The Singleton Pattern restricts instantiation... - - -

- Renders as: The Singleton Pattern restricts instantiation... -

- -

Neologisms

-

- Use <RT-neologism> for terms invented specifically for the current document or project. Neologisms are styled more strongly than conventional terms, visually distinguishing "jargon you should know" from "jargon we just made up." -

- - -We define the Hyper Tape as a construct... - - -

- Renders as: We define the Hyper Tape as a construct... -

- -

First Occurrence Rule

-

- The term system is intentionally conservative. For the tags <RT-term> and <RT-neologism>, only the first occurrence of a unique term is decorated. Subsequent mentions are rendered as normal prose. -

- -

- Uniqueness is tracked by normalizing the term text (trimmed, then lowercased). This means that Symbol and symbol count as the same term. -

- -

Forced Emphasis Variants

-

- Sometimes a later mention of a term should be emphasized again. For that purpose, the system provides explicit emphasis tags: -

- -
    -
  • <RT-term-em>
    • -
  • <RT-neologism-em>
    • -
- -

- These variants are always decorated, even if the term appeared earlier. -

- -

Automatic Definition Anchors

-

- For first occurrences, the term module automatically assigns an id attribute if one does not already exist. This creates stable anchors for future indexing and linking. -

- - -We define a Symbol as... - - -

- The first occurrence will be given an id similar to def-symbol. For neologisms, an additional marker is used, for example def-neo-hyper-tape. -

- -

Technical Content

- -

Code

-

- Use <RT-code>. If placed inline, it acts like a span. If placed as a block (with newlines), it acts like a pre formatted block with a theme aware border. -

- - -# Block Code Example -def hello(): - return "World" - - -

Mathematics

-

- Use <RT-math>. The system auto detects if it is a block equation or inline variable and wraps it in MathJax delimiters. -

-

- Inline: Let x be the input. -

-

- Block: -

- - f(x) = \sum_{i=0}^{n} x_i - - -

Navigation & Layout

- -

Automatic Table of Contents

-

- Use <RT-TOC> to insert a generated table of contents. The tag scans the document forward from its current position to collect headings. -

- -

Explicit Mode

-

- Use the level="N" attribute to target a specific heading depth. -

-
    -
  • <RT-TOC level="1">: Collects all <h1> elements until the end of the document. Best for the main document index.
    • -
  • <RT-TOC level="2">: Collects all <h2> elements until it encounters the next <h1>. Best for chapter summaries.
    • -
- -

Implicit Mode

-

- If no level is specified, the TOC scans backwards to find the nearest heading (for example H1) and assumes you want to collect children one level deeper (for example H2). -

-

- Note: Implicit mode can fail if placed before the first heading of a section. Use explicit levels for robust results. -

- -

The Title Block

-

- Use <RT-title> as the first element in your <body> (before the article container). This tag generates a standardized, styled header block with the document title and metadata. -

- -

Attributes

-
    -
  • title (Required): The main heading of the document.
    • -
  • author (Optional): The author's name. Renders in a bold accent color.
    • -
  • date (Optional): The publication or revision date.
    • -
- -

Example

- - - - - -

- Renders as: A centered, high contrast H1 followed by a serif styled metadata row containing the author and date. -

- -

The Article Container

-

- The root element must be <RT-article>. This is the boundary for the pagination logic. -

- -

Pagination

-

- The script paginate_by_element.js scans the article. It calculates the height of every element (including margins) and bundles them into <RT-page> elements. -

-

- Soft Limit Pagination: The system attempts to keep headers with their following paragraphs. It will break a page early rather than stranding a header at the bottom. -

- -

Debugging

- -

Debug Tokens

-

- RT provides a lightweight debug logging system in utility.js. Logging is controlled by a set of active debug tokens. Each log message is assigned a token, and the message prints only if that token is enabled. -

- -

- Examples of common tokens include style, layout, pagination, selector, config, and term. -

- -

How Logging is Gated

-

- Normal log and warning output are gated. The methods debug.log(token,message) and debug.warn(token,message) will print only when the token exists in debug.active_tokens. -

- -

- This prevents the console from being flooded during normal use, while still allowing deep visibility during development. -

- -

Errors are Always Printed

-

- Errors are treated differently. The method debug.error(token,message) always prints, regardless of token state. These messages represent failures that require attention. -

- -

Enabling and Disabling Tokens

-

- Tokens may be enabled or disabled in two ways: by editing the active_tokens set in utility.js, or at runtime by calling: -

- - -window.StyleRT.debug.enable('term') -window.StyleRT.debug.disable('term') - - -

- For example, the term system (RT_term.js) uses the term token. When that token is enabled, the module will print messages describing how terms were detected and which term definitions were assigned IDs. -

- -

Themes

-

- The system supports hot swapping themes by changing the script import in the head. -

-
    -
  • Dark: style/theme_dark_gold.js (Default)
    • -
  • Light: style/theme_light_gold.js
    • -
- -

Manifest

- -1. style_orchestrator.js (Example/default footer script) -2. utility.js (Math/Color physics) -3. article_tech_ref.js (Typography and CSS injection) -4. RT_code.js (Code block logic) -5. RT_math.js (MathJax wrapper) -6. RT_term.js (Term styling) -7. RT_TOC.js (Navigation generator) -8. paginate_by_element.js (Page splitter) -9. page_fixed_glow.js (Visual page container) - - - + + + RT Style System: Reference Manual + - - + + + + + + + + +

Table of Custom Tags

+ +

Style Tag Reference

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TagDescription
<RT-article>Article container.
<RT-title> + Title block and metadata. +
<RT-TOC>Generates TOC.
<RT-term>Conventional term.
<RT-term-em>Forces emphasis for a term even after first occurrence.
<RT-neologism>Project specific term.
<RT-neologism-em>Forces emphasis for a neologism even after first occurrence.
<RT-code>Code span or code block.
<RT-math>Inline or block math.
<RT-page>Automatically inserted pagination tag.
+ +

Architecture Overview

+

+ The RT Style System is a client-side, JavaScript-driven publishing framework designed to turn raw HTML into high-readability technical documentation. Unlike standard CSS frameworks, RT uses JavaScript to handle complex layout tasks like ink-ratio balancing and dynamic pagination. +

+ +

The Orchestrator

+

+ The core of the system is style_orchestrator.js. It is placed at the bottom of the HTML <body>. Its job is to: +

+
    +
  1. Detect which modules are already loaded.
    2. +
  2. Load missing modules (defaulting to Dark Theme if none is specified).
    3. +
  3. Execute the Semantics Phase (styling tags).
    4. +
  4. Wait for MathJax (if present).
    5. +
  5. Execute the Layout Phase (pagination, page rendering).
    6. +
  6. Reveal the document.
    7. +
+ +

Semantic Tags

+

+ The system relies on a specific set of custom tags in the RT- namespace to separate structure from presentation. +

+ +

Terminology

+ +

Conventional Terms

+

+ Use <RT-term> for standard, industry accepted technical terms. The system decorates only the first occurrence of each unique term so that the first appearance functions as a definition point, and later appearances do not overload the page with styling. +

+ + + The Singleton Pattern restricts instantiation... + + +

+ Renders as: The Singleton Pattern restricts instantiation... +

+ +

Neologisms

+

+ Use <RT-neologism> for terms invented specifically for the current document or project. Neologisms are styled more strongly than conventional terms, visually distinguishing "jargon you should know" from "jargon we just made up." +

+ + + We define the Hyper Tape as a construct... + + +

+ Renders as: We define the Hyper Tape as a construct... +

+ +

First Occurrence Rule

+

+ The term system is intentionally conservative. For the tags <RT-term> and <RT-neologism>, only the first occurrence of a unique term is decorated. Subsequent mentions are rendered as normal prose. +

+ +

+ Uniqueness is tracked by normalizing the term text (trimmed, then lowercased). This means that Symbol and symbol count as the same term. +

+ +

Forced Emphasis Variants

+

+ Sometimes a later mention of a term should be emphasized again. For that purpose, the system provides explicit emphasis tags: +

+ +
    +
  • <RT-term-em>
    • +
  • <RT-neologism-em>
    • +
+ +

+ These variants are always decorated, even if the term appeared earlier. +

+ +

Automatic Definition Anchors

+

+ For first occurrences, the term module automatically assigns an id attribute if one does not already exist. This creates stable anchors for future indexing and linking. +

+ + + We define a Symbol as... + + +

+ The first occurrence will be given an id similar to def-symbol. For neologisms, an additional marker is used, for example def-neo-hyper-tape. +

+ +

Technical Content

+ +

Code

+

+ Use <RT-code>. If placed inline, it acts like a span. If placed as a block (with newlines), it acts like a pre formatted block with a theme aware border. +

+ + + # Block Code Example + def hello(): + return "World" + + +

Mathematics

+

+ Use <RT-math>. The system auto detects if it is a block equation or inline variable and wraps it in MathJax delimiters. +

+

+ Inline: Let x be the input. +

+

+ Block: +

+ + f(x) = \sum_{i=0}^{n} x_i + + +

Navigation & Layout

+ +

Automatic Table of Contents

+

+ Use <RT-TOC> to insert a generated table of contents. The tag scans the document forward from its current position to collect headings. +

+ +

Explicit Mode

+

+ Use the level="N" attribute to target a specific heading depth. +

+
    +
  • <RT-TOC level="1">: Collects all <h1> elements until the end of the document. Best for the main document index.
    • +
  • <RT-TOC level="2">: Collects all <h2> elements until it encounters the next <h1>. Best for chapter summaries.
    • +
+ +

Implicit Mode

+

+ If no level is specified, the TOC scans backwards to find the nearest heading (for example H1) and assumes you want to collect children one level deeper (for example H2). +

+

+ Note: Implicit mode can fail if placed before the first heading of a section. Use explicit levels for robust results. +

+ +

The Title Block

+

+ Use <RT-title> as the first element in your <body> (before the article container). This tag generates a standardized, styled header block with the document title and metadata. +

+ +

Attributes

+
    +
  • title (Required): The main heading of the document.
    • +
  • author (Optional): The author's name. Renders in a bold accent color.
    • +
  • date (Optional): The publication or revision date.
    • +
+ +

Example

+ + + + + +

+ Renders as: A centered, high contrast H1 followed by a serif styled metadata row containing the author and date. +

+ +

The Article Container

+

+ The root element must be <RT-article>. This is the boundary for the pagination logic. +

+ +

Pagination

+

+ The script paginate_by_element.js scans the article. It calculates the height of every element (including margins) and bundles them into <RT-page> elements. +

+

+ Soft Limit Pagination: The system attempts to keep headers with their following paragraphs. It will break a page early rather than stranding a header at the bottom. +

+ +

Debugging

+ +

Debug Tokens

+

+ RT provides a lightweight debug logging system in utility.js. Logging is controlled by a set of active debug tokens. Each log message is assigned a token, and the message prints only if that token is enabled. +

+ +

+ Examples of common tokens include style, layout, pagination, selector, config, and term. +

+ +

How Logging is Gated

+

+ Normal log and warning output are gated. The methods debug.log(token,message) and debug.warn(token,message) will print only when the token exists in debug.active_tokens. +

+ +

+ This prevents the console from being flooded during normal use, while still allowing deep visibility during development. +

+ +

Errors are Always Printed

+

+ Errors are treated differently. The method debug.error(token,message) always prints, regardless of token state. These messages represent failures that require attention. +

+ +

Enabling and Disabling Tokens

+

+ Tokens may be enabled or disabled in two ways: by editing the active_tokens set in utility.js, or at runtime by calling: +

+ + + window.StyleRT.debug.enable('term') + window.StyleRT.debug.disable('term') + + +

+ For example, the term system (RT_term.js) uses the term token. When that token is enabled, the module will print messages describing how terms were detected and which term definitions were assigned IDs. +

+ +

Themes

+

+ The system supports hot swapping themes by changing the script import in the head. +

+
    +
  • Dark: style/theme_dark_gold.js (Default)
    • +
  • Light: style/theme_light_gold.js
    • +
+ +

Manifest

+ + 1. style_orchestrator.js (Example/default footer script) + 2. utility.js (Math/Color physics) + 3. article_tech_ref.js (Typography and CSS injection) + 4. RT_code.js (Code block logic) + 5. RT_math.js (MathJax wrapper) + 6. RT_term.js (Term styling) + 7. RT_TOC.js (Navigation generator) + 8. paginate_by_element.js (Page splitter) + 9. page_fixed_glow.js (Visual page container) + + + + + + -- 2.20.1