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 (21 years 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_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

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
  <head>
    <title>LON-CAPA CBI Part</title>
  </head>

  <body>
    <h1>LON-CAPA  CBI Content</h1>

       All CBI modulas (the total number approximately 400) are transferred
       from LaTeX into XML format. 
             
    <h2>CBI XML Tags</h2>    

    <ul>
      <li> Text Output Tags </li>
     <center>      
        <table border=1>          
           <tr><td align=center>tag</td><td align=center>parameters</td></tr>       
           <tr><td align=center>SectTitle</td><td align=center>number</td></tr> 
           <tr><td align=center>SubSectTitle</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>SubSect</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>SubSubSectTitle</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtHelp</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtAdvice</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtStatements</td><td align=center>letter,number</td></tr> 
           <tr><td align=center>ProbHead</td><td align=center>label</td></tr> 
           <tr><td align=center>ProbAns</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtDefinition<td align=center>letter,number</td></tr> 
           <tr><td align=center>TxtProb</td><td align=center>letter,number,title</td></tr> 
           <tr><td align=center>TxtPrac</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>SummaryItem</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>SummaryItems</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TsStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>PpStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>PraFrame</td><td align=center>number</td></tr> 
           <tr><td align=center>PraHelp</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>SuStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>SugFrame</td><td align=center>number</td></tr> 
           <tr><td align=center>WorkHere</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>WriteOnLine</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TsEnd</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>AnStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>AnEnd</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>MeStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>MeEnd</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>IdStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>IdEnd</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>IdItems</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>ChapterFirstPage</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>Order</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtHelpTwo</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtHelpThree</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtExample</td><td align=center>letter,number</td></tr> 
           <tr><td align=center>TxtCapPrac</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtInst</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TutSect</td><td align=center>number</td></tr> 
           <tr><td align=center>TutFrame</td><td align=center>letter,number,title</td></tr> 
           <tr><td align=center>TutHelp</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtRdgs</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>SugHelp</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>BriefAns</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TutPrac</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtDescr</td><td align=center></td></tr> 
           <tr><td align=center>TutFrameItem</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>mTitle</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>mAuthor</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>Asknowledgments</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>NsfAsknowledgments</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>PsStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>AsStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>AsItem</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>spcap</td><td align=center>number</td></tr> 
           <tr><td align=center>pcap</td><td align=center>number,letter</td></tr> 
           <tr><td align=center>help</td><td align=center>module,number</td></tr> 
           <tr><td align=center>GlossaryList</td><td align=center&nbsp;></td></tr> 
           <tr><td align=center><GlossaryItem/td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>LgStart</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>LgEnd</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>thmbox</td><td align=center>&nbsp;</td></tr> 
        </table>
     </center>
      <li> Math Output Tags </li>
     <center>      
        <table border=1>
          <tr><td align=center>tag</td><td align=center>parameters</td></tr>       
           <tr><td align=center>m</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>DisplayEqn</td><td align=center>letter,number</td></tr> 
           <tr><td align=center>MajorDisplayEqn</td><td align=center>letter,number</td></tr> 
           <tr><td align=center>eqn</td><td align=center>number</td></tr> 
           <tr><td align=center>FourEqns</td><td align=center>number</td></tr> 
           <tr><td align=center>ThreeEqns</td><td align=center>number</td></tr> 
        </table>
     </center>
      <li> Figures Output Tags </li>
     <center>      
        <table border=1>
          <tr><td align=center>tag</td><td align=center>parameters</td></tr>       
           <tr><td align=center>LeftFigure</td><td align=center>letter,number,figure</td></tr> 
           <tr><td align=center>TwoFigures</td><td align=center>letter1,number1,figure1,letter2,number2,figure2</td></tr> 
           <tr><td align=center>UnframedFigure</td><td align=center>figure</td></tr> 
           <tr><td align=center>FullFigure</td><td align=center>letter,number,figure</td></tr> 
           <tr><td align=center>TxtAndUnframedFigure</td><td align=center>figure</td></tr> 
           <tr><td align=center>ThreeFigures</td><td align=center>letter1,number1,figure1,letter2,number2,figure2,letter3,number3,figure3</td></tr> 
           <tr><td align=center>TxtInLineFigure</td><td align=center>figure</td></tr> 
           <tr><td align=center>TwoFullFigures</td><td align=center>figure1,figure2</td></tr> 
           <tr><td align=center>boundar</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>CaptionAfterFullFramedFigure</td><td align=center>figure</td></tr> 
           <tr><td align=center>ItemFigure</td><td align=center>figure</td></tr> 
           <tr><td align=center>CharacterFigure</td><td align=center>figure</td></tr> 
           <tr><td align=center>ThreeFullFigures</td><td align=center>figure1,figure2,figure3</td></tr> 
           <tr><td align=center>LeftUnframedEpsFigure</td><td align=center>figure</td></tr> 
           <tr><td align=center>TxtAndFigure</td><td align=center>figure</td></tr> 
        </table>
     </center>
      <li> Tables Output Tags </li>
     <center>      
        <table border=1>
          <tr><td align=center>tag</td><td align=center>parameters</td></tr>       
           <tr><td align=center>LeftTable</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>LeftTableAdd</td><td align=center>&nbsp;</td></tr> 
        </table>
     </center>
      <li> References Tags </li> 
     <center>      
        <table border=1>
          <tr><td align=center>tag</td><td align=center>parameters</td></tr>       
          <tr><td align=center>TxtFigRef</td><td align=center>letter,number</td></tr> 
          <tr><td align=center>TxtFigRefNew</td><td align=center>module,small,letter,number</td></tr> 
           <tr><td align=center>eqnno</td><td align=center>number</td></tr> 
           <tr><td align=center>AnsRef</td><td align=center>module,refer</td></tr> 
           <tr><td align=center>TxtDefEqnStaRef</td><td align=center>letter,number</td></tr> 
           <tr><td align=center>TxtDefEqnStaRefNew</td><td align=center>module,small,letter,number</td></tr> 
           <tr><td align=center>SugFrameRef</td><td align=center>module,refer</td></tr> 
           <tr><td align=center>PraFrameRef</td><td align=center>module,refer</td></tr> 
           <tr><td align=center>TxtSectRef</td><td align=center>module,small,section</td></tr> 
           <tr><td align=center>TxtProbRef</td><td align=center>module,small,letter,number</td></tr> 
           <tr><td align=center>TxtEqnChRef</td><td align=center>number1,small,letter,number2</td></tr> 
           <tr><td align=center>TxtSectChRef</td><td align=center>module,letter,small,number</td></tr> 
           <tr><td align=center>prrqone</td><td align=center>arg</td></tr> 
           <tr><td align=center>TutSectRef</td><td align=center>module,small,refer</td></tr> 
           <tr><td align=center>TutFrameRef</td><td align=center>module,letter,small,number</td></tr> 
           <tr><td align=center>TxtStaChRef</td><td align=center>module,letter,small,number</td></tr> 
           <tr><td align=center>SugFrameChRef</td><td align=center>module,number</td></tr> 
           <tr><td align=center>ChRef</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>TxtProChRef</td><td align=center>number1,small,letter,number2</td></tr> 
           <tr><td align=center>TxtDefChRef</td><td align=center>number1,small,letter,number2</td></tr> 
           <tr><td align=center>TxtFigChRef</td><td align=center>module,letter,small,number</td></tr> 
           <tr><td align=center>ChRefNo</td><td align=center>module</td></tr> 
           <tr><td align=center>furtherhelp</td><td align=center>module,number</td></tr> 
        </table>
     </center>
      <li> Metadata Tags </li>
     <center>      
        <table border=1>
          <tr><td align=center>tag</td><td align=center>parameters</td></tr>       
           <tr><td align=center>revhist</td><td align=center>revision</td></tr>  
           <tr><td align=center>HoursPages</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>index</td><td align=center>content,list</td></tr>            
           <tr><td align=center>IdTitle</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>IdAuthor</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>IdVersEval</td><td align=center>data,stage</td></tr> 
           <tr><td align=center>HRO</td><td align=center>number</td></tr> 
           <tr><td align=center>TX</td><td align=center>number</td></tr> 
           <tr><td align=center>TS</td><td align=center>number</td></tr> 
           <tr><td align=center>AN</td><td align=center>number</td></tr> 
           <tr><td align=center>ME</td><td align=center>number</td></tr> 
           <tr><td align=center>PS</td><td align=center>number</td></tr> 
           <tr><td align=center>LG</td><td align=center>number</td></tr> 
           <tr><td align=center>RD</td><td align=center>number</td></tr> 
           <tr><td align=center>AS</td><td align=center>number</td></tr> 
           <tr><td align=center>InputSkills</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>KnowledgeSkills</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>ProblemSolvingSkills</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>RuleApplicationSkills</td><td align=center>&nbsp;</td></tr> 
           <tr><td align=center>OptionalResources</td><td align=center>&nbsp;</td></tr>
           <tr><td align=center>RequiredResources</td><td align=center>&nbsp;</td></tr>
           <tr><td align=center>PostOptions</td><td align=center>&nbsp;</td></tr> 
        </table>
     </center>
    </ul>

         In addition to these set of tags a lot of CBI modulas use the standard HTML tags, 
         such as <b>b,em,i,h1,h2,...</b>.
  
 
    <h2>LaTeX incorporated in XML </h2>    

        All <b> math tags </b> use chunks of LaTeX text which is translated by tth/ttm to produce
        the real visible HTML-like output. 
    <p>
        <i> Examples: </i>
    </p>
     <ul>
       <li> formula: <br></br> &lt;eqn number="(23)"&gt;&lt;m&gt;\[ \cos\pi = 0 \]&lt;/m&gt;&lt;/eqn&gt; </li>
       <li> math embedded in text:  <br></br>  &lt;m&gt; $ \frac{\alpha}{2} $ &lt;/m&gt; </li> 
     </ul>

    <h2>CBI Style File</h2>    

       <p>
       CBI style file consists of separate entries. Each entry defines one tag (opening or closing) and 
       the rules to work with it for different targets: web output, text output (paper version of CBI 
       material), metadata (database), ... . Each opening tag posess its closing counterpart.
       </p>
       The formal structure of the pair of entries (opening or closing tags):
       <pre>
          &lt;definetag name = "actual name" parms="list of the actual parameters"&gt;   
             &lt;meta&gt;    
                 &lt;output&gt;    
                    how it works for metadata target    
             &lt;/meta&gt;    
             &lt;render&gt;    
              &lt;web&gt;    
                 how it works for web target    
              &lt;/web&gt;    
              &lt;tex&gt;    
                 how it works for text target    
              &lt;/tex&gt;    
             &lt;/render&gt;    
          &lt;/definetag&gt;    
    
    
          &lt;definetag name = "/actual name"&gt;      
             &lt;meta&gt;       
                    how it works for metadata target       
                 &lt;/output&gt;  
             &lt;/meta&gt;    
             &lt;render&gt;    
              &lt;web&gt;     
                 how it works for web target    
              &lt;/web&gt;    
              &lt;tex&gt;        
                 how it works for text target          
              &lt;/tex&gt;    
             &lt;/render&gt;    
          &lt;/definetag&gt;    
</pre>
         <p>   
           Note, that <i>list of the actual parameters</i> is used only in the style file and
           does not influence on the functionality of the tag. The &lt;output&gt; tag redefine 
           the standard output in the parser (it is always open for <i>web</i> and <i>text</i>
           target and closed for <i>metadata</i> by default).
         </p>
    <p>
        <i> Examples: </i>
    </p> 
        <ul>
          <li> <b>revhist</b> tag keeps the revision history (it is used only for <i>metadata</i> 
               and <i>text</i> tergets) <br></br>
             <pre>
    &lt;definetag name = "revhist" parms = "revision"&gt;
   &lt;meta&gt;
      &lt;output&gt;
      &lt;revhist display="Revision History"&gt; $revision
   &lt;/meta&gt;
   &lt;render&gt;
      &lt;tex&gt;
         \revhist{$revision}
      &lt;/tex&gt;
   &lt;/render&gt;
&lt;/definetag&gt;


&lt;definetag name = "/revhist"&gt;
   &lt;meta&gt;
      &lt;/revhist&gt;
      &lt;/output&gt;
   &lt;/meta&gt;
   &lt;render&gt;
      &lt;tex&gt;
      &lt;/tex&gt;
   &lt;/render&gt;
&lt;/definetag&gt;
             </pre>
          </li>
          <li> <b></b>UnframedFigure</b> tag is used only for <i>web</i> 
               and <i>text</i> tergets <br></br>
             <pre>

&lt;definetag name = "UnframedFigure" parms="figure"&gt;
   &lt;meta&gt;
   &lt;/meta&gt;
   &lt;render&gt;
      &lt;web&gt;
         &lt;p&gt;&lt;center&gt;&lt;img src="$figure.gif" align=center border=1&gt;
      &lt;/web&gt;
      &lt;tex&gt;
          \UnframedFigure{$figure}
      &lt;/tex&gt;
  &lt;/render&gt;
&lt;/definetag&gt;


&lt;definetag name = "/UnframedFigure"&gt;
   &lt;meta&gt;
   &lt;/meta&gt;
   &lt;render&gt;
      &lt;web&gt;
        &lt;/img&gt;&lt;/center&gt;&lt;/p&gt;
      &lt;/web&gt;
      &lt;tex&gt;          
      &lt;/tex&gt;
  &lt;/render&gt;
&lt;/definetag&gt;

             </pre>
          </li>








    <hr>
    <address><a href="mailto:sakharuk@lite.msu.edu">Alexander Sakharuk</a></address>
<!-- Created: Wen Nov 29 2000 -->
<!-- hhmts start -->
Last modified: Een Nov 29 2000
<!-- hhmts end -->
  </body>
</html>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>