doc/cbi/cbi.html - view

File: [LON-CAPA] / doc / cbi / cbi.html
Revision 1.1: download - view: text, annotated - select for diffs
Wed Nov 29 19:36:41 2000 UTC (24 years, 2 months ago) by sakharuk
Branches: MAIN
CVS tags: version_2_9_X, version_2_9_99_0, version_2_9_1, version_2_9_0, version_2_8_X, version_2_8_99_1, version_2_8_99_0, version_2_8_2, version_2_8_1, version_2_8_0, version_2_7_X, version_2_7_99_1, version_2_7_99_0, version_2_7_1, version_2_7_0, version_2_6_X, version_2_6_99_1, version_2_6_99_0, version_2_6_3, version_2_6_2, version_2_6_1, version_2_6_0, version_2_5_X, version_2_5_99_1, version_2_5_99_0, version_2_5_2, version_2_5_1, version_2_5_0, version_2_4_X, version_2_4_99_0, version_2_4_2, version_2_4_1, version_2_4_0, version_2_3_X, version_2_3_99_0, version_2_3_2, version_2_3_1, version_2_3_0, version_2_2_X, version_2_2_99_1, version_2_2_99_0, version_2_2_2, version_2_2_1, version_2_2_0, version_2_1_X, version_2_1_99_3, version_2_1_99_2, version_2_1_99_1, version_2_1_99_0, version_2_1_3, version_2_1_2, version_2_1_1, version_2_1_0, version_2_12_X, version_2_11_X, version_2_11_6_msu, version_2_11_6, version_2_11_5_msu, version_2_11_5, version_2_11_4_uiuc, version_2_11_4_msu, version_2_11_4, version_2_11_3_uiuc, version_2_11_3_msu, version_2_11_3, version_2_11_2_uiuc, version_2_11_2_msu, version_2_11_2_educog, version_2_11_2, version_2_11_1, version_2_11_0_RC3, version_2_11_0_RC2, version_2_11_0_RC1, version_2_11_0, version_2_10_X, version_2_10_1, version_2_10_0_RC2, version_2_10_0_RC1, version_2_10_0, version_2_0_X, version_2_0_99_1, version_2_0_2, version_2_0_1, version_2_0_0, version_1_99_3, version_1_99_2, version_1_99_1_tmcc, version_1_99_1, version_1_99_0_tmcc, version_1_99_0, version_1_3_X, version_1_3_3, version_1_3_2, version_1_3_1, version_1_3_0, version_1_2_X, version_1_2_99_1, version_1_2_99_0, version_1_2_1, version_1_2_0, version_1_1_X, version_1_1_99_5, version_1_1_99_4, version_1_1_99_3, version_1_1_99_2, version_1_1_99_1, version_1_1_99_0, version_1_1_3, version_1_1_2, version_1_1_1, version_1_1_0, version_1_0_99_3, version_1_0_99_2, version_1_0_99_1, version_1_0_99, version_1_0_3, version_1_0_2, version_1_0_1, version_1_0_0, version_0_99_5, version_0_99_4, version_0_99_3, version_0_99_2, version_0_99_1, version_0_99_0, version_0_6_2, version_0_6, version_0_5_1, version_0_5, version_0_4, stable_2002_spring, stable_2002_july, stable_2002_april, stable_2001_fall, loncapaMITrelate_1, language_hyphenation_merge, language_hyphenation, conference_2003, bz6209-base, bz6209, STABLE, HEAD, GCI_3, GCI_2, GCI_1, BZ4492-merge, BZ4492-feature_horizontal_radioresponse, BZ4492-feature_Support_horizontal_radioresponse, BZ4492-Support_horizontal_radioresponse

just added this file

1: <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> 2: <html> 3: <head> 4: <title>LON-CAPA CBI Part</title> 5: </head> 6: 7: <body> 8: <h1>LON-CAPA CBI Content</h1> 9: 10: All CBI modulas (the total number approximately 400) are transferred 11: from LaTeX into XML format. 12: 13: <h2>CBI XML Tags</h2> 14: 15: <ul> 16: <li> Text Output Tags </li> 17: <center> 18: <table border=1> 19: <tr><td align=center>tag</td><td align=center>parameters</td></tr> 20: <tr><td align=center>SectTitle</td><td align=center>number</td></tr> 21: <tr><td align=center>SubSectTitle</td><td align=center> </td></tr> 22: <tr><td align=center>SubSect</td><td align=center> </td></tr> 23: <tr><td align=center>SubSubSectTitle</td><td align=center> </td></tr> 24: <tr><td align=center>TxtHelp</td><td align=center> </td></tr> 25: <tr><td align=center>TxtAdvice</td><td align=center> </td></tr> 26: <tr><td align=center>TxtStatements</td><td align=center>letter,number</td></tr> 27: <tr><td align=center>ProbHead</td><td align=center>label</td></tr> 28: <tr><td align=center>ProbAns</td><td align=center> </td></tr> 29: <tr><td align=center>TxtDefinition<td align=center>letter,number</td></tr> 30: <tr><td align=center>TxtProb</td><td align=center>letter,number,title</td></tr> 31: <tr><td align=center>TxtPrac</td><td align=center> </td></tr> 32: <tr><td align=center>SummaryItem</td><td align=center> </td></tr> 33: <tr><td align=center>SummaryItems</td><td align=center> </td></tr> 34: <tr><td align=center>TsStart</td><td align=center> </td></tr> 35: <tr><td align=center>PpStart</td><td align=center> </td></tr> 36: <tr><td align=center>PraFrame</td><td align=center>number</td></tr> 37: <tr><td align=center>PraHelp</td><td align=center> </td></tr> 38: <tr><td align=center>SuStart</td><td align=center> </td></tr> 39: <tr><td align=center>SugFrame</td><td align=center>number</td></tr> 40: <tr><td align=center>WorkHere</td><td align=center> </td></tr> 41: <tr><td align=center>WriteOnLine</td><td align=center> </td></tr> 42: <tr><td align=center>TsEnd</td><td align=center> </td></tr> 43: <tr><td align=center>AnStart</td><td align=center> </td></tr> 44: <tr><td align=center>AnEnd</td><td align=center> </td></tr> 45: <tr><td align=center>MeStart</td><td align=center> </td></tr> 46: <tr><td align=center>MeEnd</td><td align=center> </td></tr> 47: <tr><td align=center>IdStart</td><td align=center> </td></tr> 48: <tr><td align=center>IdEnd</td><td align=center> </td></tr> 49: <tr><td align=center>IdItems</td><td align=center> </td></tr> 50: <tr><td align=center>TxStart</td><td align=center> </td></tr> 51: <tr><td align=center>ChapterFirstPage</td><td align=center> </td></tr> 52: <tr><td align=center>Order</td><td align=center> </td></tr> 53: <tr><td align=center>TxtHelpTwo</td><td align=center> </td></tr> 54: <tr><td align=center>TxtHelpThree</td><td align=center> </td></tr> 55: <tr><td align=center>TxtExample</td><td align=center>letter,number</td></tr> 56: <tr><td align=center>TxtCapPrac</td><td align=center> </td></tr> 57: <tr><td align=center>TxtInst</td><td align=center> </td></tr> 58: <tr><td align=center>TutSect</td><td align=center>number</td></tr> 59: <tr><td align=center>TutFrame</td><td align=center>letter,number,title</td></tr> 60: <tr><td align=center>TutHelp</td><td align=center> </td></tr> 61: <tr><td align=center>TxtRdgs</td><td align=center> </td></tr> 62: <tr><td align=center>SugHelp</td><td align=center> </td></tr> 63: <tr><td align=center>BriefAns</td><td align=center> </td></tr> 64: <tr><td align=center>TutPrac</td><td align=center> </td></tr> 65: <tr><td align=center>TxtDescr</td><td align=center></td></tr> 66: <tr><td align=center>TutFrameItem</td><td align=center> </td></tr> 67: <tr><td align=center>mTitle</td><td align=center> </td></tr> 68: <tr><td align=center>mAuthor</td><td align=center> </td></tr> 69: <tr><td align=center>Asknowledgments</td><td align=center> </td></tr> 70: <tr><td align=center>NsfAsknowledgments</td><td align=center> </td></tr> 71: <tr><td align=center>PsStart</td><td align=center> </td></tr> 72: <tr><td align=center>AsStart</td><td align=center> </td></tr> 73: <tr><td align=center>AsItem</td><td align=center> </td></tr> 74: <tr><td align=center>spcap</td><td align=center>number</td></tr> 75: <tr><td align=center>pcap</td><td align=center>number,letter</td></tr> 76: <tr><td align=center>help</td><td align=center>module,number</td></tr> 77: <tr><td align=center>GlossaryList</td><td align=center ></td></tr> 78: <tr><td align=center><GlossaryItem/td><td align=center> </td></tr> 79: <tr><td align=center>LgStart</td><td align=center> </td></tr> 80: <tr><td align=center>LgEnd</td><td align=center> </td></tr> 81: <tr><td align=center>thmbox</td><td align=center> </td></tr> 82: </table> 83: </center> 84: <li> Math Output Tags </li> 85: <center> 86: <table border=1> 87: <tr><td align=center>tag</td><td align=center>parameters</td></tr> 88: <tr><td align=center>m</td><td align=center> </td></tr> 89: <tr><td align=center>DisplayEqn</td><td align=center>letter,number</td></tr> 90: <tr><td align=center>MajorDisplayEqn</td><td align=center>letter,number</td></tr> 91: <tr><td align=center>eqn</td><td align=center>number</td></tr> 92: <tr><td align=center>FourEqns</td><td align=center>number</td></tr> 93: <tr><td align=center>ThreeEqns</td><td align=center>number</td></tr> 94: </table> 95: </center> 96: <li> Figures Output Tags </li> 97: <center> 98: <table border=1> 99: <tr><td align=center>tag</td><td align=center>parameters</td></tr> 100: <tr><td align=center>LeftFigure</td><td align=center>letter,number,figure</td></tr> 101: <tr><td align=center>TwoFigures</td><td align=center>letter1,number1,figure1,letter2,number2,figure2</td></tr> 102: <tr><td align=center>UnframedFigure</td><td align=center>figure</td></tr> 103: <tr><td align=center>FullFigure</td><td align=center>letter,number,figure</td></tr> 104: <tr><td align=center>TxtAndUnframedFigure</td><td align=center>figure</td></tr> 105: <tr><td align=center>ThreeFigures</td><td align=center>letter1,number1,figure1,letter2,number2,figure2,letter3,number3,figure3</td></tr> 106: <tr><td align=center>TxtInLineFigure</td><td align=center>figure</td></tr> 107: <tr><td align=center>TwoFullFigures</td><td align=center>figure1,figure2</td></tr> 108: <tr><td align=center>boundar</td><td align=center> </td></tr> 109: <tr><td align=center>CaptionAfterFullFramedFigure</td><td align=center>figure</td></tr> 110: <tr><td align=center>ItemFigure</td><td align=center>figure</td></tr> 111: <tr><td align=center>CharacterFigure</td><td align=center>figure</td></tr> 112: <tr><td align=center>ThreeFullFigures</td><td align=center>figure1,figure2,figure3</td></tr> 113: <tr><td align=center>LeftUnframedEpsFigure</td><td align=center>figure</td></tr> 114: <tr><td align=center>TxtAndFigure</td><td align=center>figure</td></tr> 115: </table> 116: </center> 117: <li> Tables Output Tags </li> 118: <center> 119: <table border=1> 120: <tr><td align=center>tag</td><td align=center>parameters</td></tr> 121: <tr><td align=center>LeftTable</td><td align=center> </td></tr> 122: <tr><td align=center>LeftTableAdd</td><td align=center> </td></tr> 123: </table> 124: </center> 125: <li> References Tags </li> 126: <center> 127: <table border=1> 128: <tr><td align=center>tag</td><td align=center>parameters</td></tr> 129: <tr><td align=center>TxtFigRef</td><td align=center>letter,number</td></tr> 130: <tr><td align=center>TxtFigRefNew</td><td align=center>module,small,letter,number</td></tr> 131: <tr><td align=center>eqnno</td><td align=center>number</td></tr> 132: <tr><td align=center>AnsRef</td><td align=center>module,refer</td></tr> 133: <tr><td align=center>TxtDefEqnStaRef</td><td align=center>letter,number</td></tr> 134: <tr><td align=center>TxtDefEqnStaRefNew</td><td align=center>module,small,letter,number</td></tr> 135: <tr><td align=center>SugFrameRef</td><td align=center>module,refer</td></tr> 136: <tr><td align=center>PraFrameRef</td><td align=center>module,refer</td></tr> 137: <tr><td align=center>TxtSectRef</td><td align=center>module,small,section</td></tr> 138: <tr><td align=center>TxtProbRef</td><td align=center>module,small,letter,number</td></tr> 139: <tr><td align=center>TxtEqnChRef</td><td align=center>number1,small,letter,number2</td></tr> 140: <tr><td align=center>TxtSectChRef</td><td align=center>module,letter,small,number</td></tr> 141: <tr><td align=center>prrqone</td><td align=center>arg</td></tr> 142: <tr><td align=center>TutSectRef</td><td align=center>module,small,refer</td></tr> 143: <tr><td align=center>TutFrameRef</td><td align=center>module,letter,small,number</td></tr> 144: <tr><td align=center>TxtStaChRef</td><td align=center>module,letter,small,number</td></tr> 145: <tr><td align=center>SugFrameChRef</td><td align=center>module,number</td></tr> 146: <tr><td align=center>ChRef</td><td align=center> </td></tr> 147: <tr><td align=center>TxtProChRef</td><td align=center>number1,small,letter,number2</td></tr> 148: <tr><td align=center>TxtDefChRef</td><td align=center>number1,small,letter,number2</td></tr> 149: <tr><td align=center>TxtFigChRef</td><td align=center>module,letter,small,number</td></tr> 150: <tr><td align=center>ChRefNo</td><td align=center>module</td></tr> 151: <tr><td align=center>furtherhelp</td><td align=center>module,number</td></tr> 152: </table> 153: </center> 154: <li> Metadata Tags </li> 155: <center> 156: <table border=1> 157: <tr><td align=center>tag</td><td align=center>parameters</td></tr> 158: <tr><td align=center>revhist</td><td align=center>revision</td></tr> 159: <tr><td align=center>HoursPages</td><td align=center> </td></tr> 160: <tr><td align=center>index</td><td align=center>content,list</td></tr> 161: <tr><td align=center>IdTitle</td><td align=center> </td></tr> 162: <tr><td align=center>IdAuthor</td><td align=center> </td></tr> 163: <tr><td align=center>IdVersEval</td><td align=center>data,stage</td></tr> 164: <tr><td align=center>HRO</td><td align=center>number</td></tr> 165: <tr><td align=center>TX</td><td align=center>number</td></tr> 166: <tr><td align=center>TS</td><td align=center>number</td></tr> 167: <tr><td align=center>AN</td><td align=center>number</td></tr> 168: <tr><td align=center>ME</td><td align=center>number</td></tr> 169: <tr><td align=center>PS</td><td align=center>number</td></tr> 170: <tr><td align=center>LG</td><td align=center>number</td></tr> 171: <tr><td align=center>RD</td><td align=center>number</td></tr> 172: <tr><td align=center>AS</td><td align=center>number</td></tr> 173: <tr><td align=center>InputSkills</td><td align=center> </td></tr> 174: <tr><td align=center>KnowledgeSkills</td><td align=center> </td></tr> 175: <tr><td align=center>ProblemSolvingSkills</td><td align=center> </td></tr> 176: <tr><td align=center>RuleApplicationSkills</td><td align=center> </td></tr> 177: <tr><td align=center>OptionalResources</td><td align=center> </td></tr> 178: <tr><td align=center>RequiredResources</td><td align=center> </td></tr> 179: <tr><td align=center>PostOptions</td><td align=center> </td></tr> 180: </table> 181: </center> 182: </ul> 183: 184: In addition to these set of tags a lot of CBI modulas use the standard HTML tags, 185: such as <b>b,em,i,h1,h2,...</b>. 186: 187: 188: <h2>LaTeX incorporated in XML </h2> 189: 190: All <b> math tags </b> use chunks of LaTeX text which is translated by tth/ttm to produce 191: the real visible HTML-like output. 192: <p> 193: <i> Examples: </i> 194: </p> 195: <ul> 196: <li> formula: <br></br> <eqn number="(23)"><m>\[ \cos\pi = 0 \]</m></eqn> </li> 197: <li> math embedded in text: <br></br> <m> $ \frac{\alpha}{2} $ </m> </li> 198: </ul> 199: 200: <h2>CBI Style File</h2> 201: 202: <p> 203: CBI style file consists of separate entries. Each entry defines one tag (opening or closing) and 204: the rules to work with it for different targets: web output, text output (paper version of CBI 205: material), metadata (database), ... . Each opening tag posess its closing counterpart. 206: </p> 207: The formal structure of the pair of entries (opening or closing tags): 208: <pre> 209: <definetag name = "actual name" parms="list of the actual parameters"> 210: <meta> 211: <output> 212: how it works for metadata target 213: </meta> 214: <render> 215: <web> 216: how it works for web target 217: </web> 218: <tex> 219: how it works for text target 220: </tex> 221: </render> 222: </definetag> 223: 224: 225: <definetag name = "/actual name"> 226: <meta> 227: how it works for metadata target 228: </output> 229: </meta> 230: <render> 231: <web> 232: how it works for web target 233: </web> 234: <tex> 235: how it works for text target 236: </tex> 237: </render> 238: </definetag> 239: </pre> 240: <p> 241: Note, that <i>list of the actual parameters</i> is used only in the style file and 242: does not influence on the functionality of the tag. The <output> tag redefine 243: the standard output in the parser (it is always open for <i>web</i> and <i>text</i> 244: target and closed for <i>metadata</i> by default). 245: </p> 246: <p> 247: <i> Examples: </i> 248: </p> 249: <ul> 250: <li> <b>revhist</b> tag keeps the revision history (it is used only for <i>metadata</i> 251: and <i>text</i> tergets) <br></br> 252: <pre> 253: <definetag name = "revhist" parms = "revision"> 254: <meta> 255: <output> 256: <revhist display="Revision History"> $revision 257: </meta> 258: <render> 259: <tex> 260: \revhist{$revision} 261: </tex> 262: </render> 263: </definetag> 264: 265: 266: <definetag name = "/revhist"> 267: <meta> 268: </revhist> 269: </output> 270: </meta> 271: <render> 272: <tex> 273: </tex> 274: </render> 275: </definetag> 276: </pre> 277: </li> 278: <li> <b></b>UnframedFigure</b> tag is used only for <i>web</i> 279: and <i>text</i> tergets <br></br> 280: <pre> 281: 282: <definetag name = "UnframedFigure" parms="figure"> 283: <meta> 284: </meta> 285: <render> 286: <web> 287: <p><center><img src="$figure.gif" align=center border=1> 288: </web> 289: <tex> 290: \UnframedFigure{$figure} 291: </tex> 292: </render> 293: </definetag> 294: 295: 296: <definetag name = "/UnframedFigure"> 297: <meta> 298: </meta> 299: <render> 300: <web> 301: </img></center></p> 302: </web> 303: <tex> 304: </tex> 305: </render> 306: </definetag> 307: 308: </pre> 309: </li> 310: 311: 312: 313: 314: 315: 316: 317: 318: <hr> 319: <address><a href="mailto:sakharuk@lite.msu.edu">Alexander Sakharuk</a></address> 320:  321:  322: Last modified: Een Nov 29 2000 323:  324: </body> 325: </html>