ReferenceManualScripts/data/IndexContentTemplate.html

0001 <div class="content">
0002 <script>
0003 function changeState(item) {
0004     item.slideToggle("slow");
0005 }
0006
0007 $( document ).ready(function() {
0008     $(".doxyTable > tbody > tr").each(function(){
0009         var row = $(this);
0010         // skip first row (header), you dont need to assing it accordion
0011         // trigger function. it is also the same for rows which doesn't have
0012         // id attribute. if a row doesn't have id attr, that means it is
0013         // accordion row
0014         if(row.attr('id') == 'header' || !row.attr('id')) return;
0015
0016         // if it has id attribute, assign trigger function
0017         row.click(function(){
0018             $('div#'+row.attr('id')).slideToggle(256);
0019             // we dont want to load whole iframes before they are showed
0020             var iframe = $('div#'+row.attr('id')).find('iframe');
0021             // no need to set the source again again if already set
0022             if(iframe.attr('src')) return;
0023
0024             iframe.attr('src', iframe.attr('data-src'));
0025         });
0026     });
0027 });
0028 </script>
0029
0030 <h1>CMSSW Documentation</h1>
0031 <h2 id="version"></h2>
0032
0033 <table class="doxyTable" cellpadding="0" cellspacing="0">
0034   <tr class="top" valign="top" id="header">
0035     <th class="domain">Domain</th>
0036     <th class="contact">Contact</th>
0037   </tr>
0038 </table>
0039
0040 <br>
0041
0042 <p style="margin:2px 10px;">
0043 Learn <a onClick='$("#howToBuildRefMan").slideToggle(100);' style="cursor:pointer;">how to build Reference Manual</a>
0044 </p>
0045 <div id="howToBuildRefMan" style="display:none;text-align:left; border: 1px solid #999; margin:2px 10px;padding:10px">
0046     This is the CMSSW Reference Manual, the reference documentation of all classes and packages in CMSSW.<p>
0047     This page explains how to write the documentation for your code.
0048
0049     </p><h2 style="text-align:left">Class Documentation</h2>
0050
0051     Classes and methods are documented with properly formatted <a target="_blank" class="el" href="d3/d88/namespacecomments.html">comments</a> in the code.<p>
0052     Here is a template of a documented <a target="_blank" href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Documentation/CodingRules/Template.h?rev=HEAD&amp;cvsroot=CMSSW&amp;content-type=text/vnd.viewcvs-markup">.h file</a>, and of a <a target="_blank" href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Documentation/CodingRules/Template.cc?rev=HEAD&amp;cvsroot=CMSSW&amp;content-type=text/vnd.viewcvs-markup">.cc file</a>. The resulting doxygen page is <a target="_blank" class="el" href="d6/d3e/classTemplate.html">here</a>.
0053
0054     </p><h2 style="text-align:left">Package Documentation</h2>
0055
0056     Each package should contain a very brief description of its content and purpose. Remember that this is a reference, and not a user's guide: tutorials, howtos, etc. are best documented in the <a target="_blank" href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuide">CMS Offline Guide</a> and in the <a target="_blank" href="https://twiki.cern.ch/twiki/bin/view/CMS/WorkBook">WorkBook</a>. Cross links between the CMS Offline Guide and the WorkBook and this manual are a good way to avoid duplication of content.<p>
0057     This documentation should be written in a file [Package]/doc/[Package].doc. The simplest way of doing this is to go to the doc/ directory in your package and then run the script
0058     <a target="_blank" href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/*checkout*/CMSSW/Documentation/ReferenceManualScripts/scripts/makePackageDoc?rev=HEAD&amp;cvsroot=CMSSW">makePackageDoc</a>,
0059      which is available in your PATH.
0060
0061     </p><h2 style="text-align:left"> How to generate your documentation locally </h2>
0062     One you have updated your documentation, you can look at how it displays in the following way:
0063
0064      <ul>
0065        <li>check out the following packages:
0066     <pre> &gt; cmsrel CMSSW_7_X_X
0067      &gt; cd CMSSW_7_X_X/
0068      &gt; cmsenv
0069      &gt; git cms-addpkg Documentation
0070
0071      &gt; generate_reference_manual
0072
0073      wait...
0074
0075      &gt; firefox doc/html/index.html </pre>
0076       </li>
0077     </ul>
0078 </div>
0079 <p style="margin-left:10px;">
0080 Learn more about <a target="_blank" href="http://www.stack.nl/~dimitri/doxygen/commands.html">special doxygen commands</a>
0081 </p>
0082
0083 </div>