Documentation Directory Structure

The typical Siemens Software and Mentor Documentation System has a standard directory structure.

The documentation directory is either named docs, doc, or shared. This docs directory is self-contained and portable; all links between documents (PDF and HTML) are relative. Thus, you can copy the docs, doc, or shared directory to your computer and use it outside the software tree.

{root of product tree} 
    | 
    |-- bin 
    |   |-- mgcdocs (UNIX or Linux only) 
    | 
    |-- docs|doc|shared 
    |   |-- data 
    |   |-- htmldocs 
    |   |   |-- {handleA} 
    |   |   |-- {handleB} 
    |   |    
    |   |-- infohubs 
    |   |   |-- index.html 
    |   |   |-- {ih_handle1}_ih 
    |   |   |-- {ih_handle2}_ih 
    |   |    
    |   |-- legal 
    |   |    
    |   |-- mgc_doc_options.ini 
    |   |-- videos           
    |   |   |-- {handleM} 
    |   |       |-- {handleM}.html 
    |   |    
    |   |-- pdfdocs 
    |   |   |-- {handleA}.pdf 
    |   |   |-- {handleB}.pdf