OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00
Code Activity

0024269: Content of occt documentation should be formated

Browse Source 
building subsection introduced; wok moved to dev guides section;
Requirements and Installation sections were interchanged;
some Unicode characters removed from .md files; \DeclareUnicodeCharacter{00A0}{ } instruction added into refman file
images insertion rolled back to dual html,latex insertion; mainpage now is processed (index.tex);
surplus part of overview has been removed
foundation_classes.md and technical_overview.md updated;
Reviewed step, tobj, xde and partly iges; Corrections in other guides.
Overview installation and requirements changes updated
This commit is contained in:
ysn
2013-11-01 16:47:47 +04:00
committed by bugmaster
parent 4df5470212
commit dba69de2f0
54 changed files with 9258 additions and 9667 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
dox/occdoc.tcl
View File

@@ -340,8 +340,8 @@ proc OverviewDoc_MakeRefmanTex {fileName latexDir docLabel verboseMode} {
puts $texfile "\\fancyhead\[RO\]{\\fancyplain{}{\\bfseries\\thepage}}"
puts $texfile "\\fancyfoot\[LE\]{\\fancyplain{}{}}"
puts $texfile "\\fancyfoot\[CE\]{\\fancyplain{}{}}"
puts $texfile "\\fancyfoot\[RE\]{\\fancyplain{}{\\bfseries\\scriptsize © Open CASCADE Technology 2001\-2013}}"
puts $texfile "\\fancyfoot\[LO\]{\\fancyplain{}{\\bfseries\\scriptsize © Open CASCADE Technology 2001\-2013}}"
puts $texfile "\\fancyfoot\[RE\]{\\fancyplain{}{\\bfseries\\scriptsize (c) Open CASCADE Technology 2001\-2013}}"
puts $texfile "\\fancyfoot\[LO\]{\\fancyplain{}{\\bfseries\\scriptsize (c) Open CASCADE Technology 2001\-2013}}"
puts $texfile "\\fancyfoot\[CO\]{\\fancyplain{}{}}"
puts $texfile "\\fancyfoot\[RO\]{\\fancyplain{}{}}"
puts $texfile "\\renewcommand{\\footrulewidth}{0.4pt}"
@@ -378,6 +378,7 @@ proc OverviewDoc_MakeRefmanTex {fileName latexDir docLabel verboseMode} {
puts $texfile "}"
puts $texfile "\n"
puts $texfile "%===== C O N T E N T S =====\n"
# puts $texfile "\\DeclareUnicodeCharacter{00A0}{ }"
puts $texfile "\\begin{document}"
puts $texfile ""
puts $texfile "% Titlepage & ToC"
@@ -386,7 +387,7 @@ proc OverviewDoc_MakeRefmanTex {fileName latexDir docLabel verboseMode} {
puts $texfile "\\begin{titlepage}"
puts $texfile "\\vspace*{7cm}"
puts $texfile "\\begin{center}%"
puts $texfile "\\includegraphics\[width=0.75\\textwidth, height=0.2\\textheight\]{occttransparent.png}\\\\\\\\"
puts $texfile "\\includegraphics\[width=0.75\\textwidth, height=0.2\\textheight\]{overview_occttransparent.png}\\\\\\\\"
puts $texfile "{\\Large Open C\\-A\\-S\\-C\\-A\\-D\\-E Technology \\\\\[1ex\]\\Large 6.\\-6.\\-0 }\\\\"
puts $texfile "\\vspace*{1cm}"
puts $texfile "{\\Large $docLabel}\\\\"
@@ -423,8 +424,15 @@ proc OverviewDoc_ProcessTex {{texFiles {}} {latexDir} verboseMode} {
if {$verboseMode == "YES"} {
puts "INFO: Preprocessing file $TEX"
}
if {![file exists $TEX]} {
puts "file $TEX doesn't exist"
return
}
set IN_F [open "$TEX" r]
set TMPFILENAME "$latexDir/temp.tex"
set OUT_F [open $TMPFILENAME w]
while {1} {
@@ -521,13 +529,13 @@ proc OverviewDoc_Main { {docfiles {}} generatorMode docLabel verboseMode} {
}
# Prepare a list of TeX files, generated by Doxygen
puts "go to $LATEXDIR"
cd $LATEXDIR
set TEXFILES [glob $LATEXDIR -type f -directory $LATEXDIR -tails "*.tex" ]
set REFMAN_IDX [lsearch $TEXFILES "refman.tex"]
set TEXFILES [lreplace $TEXFILES $REFMAN_IDX $REFMAN_IDX]
set REFMAN_IDX [lsearch $TEXFILES "index.tex"]
set TEXFILES [lreplace $TEXFILES $REFMAN_IDX $REFMAN_IDX]
set IDX [lsearch $TEXFILES "$LATEXDIR"]
while { $IDX != -1} {
@@ -535,10 +543,10 @@ proc OverviewDoc_Main { {docfiles {}} generatorMode docLabel verboseMode} {
set IDX [lsearch $TEXFILES "$LATEXDIR"]
}
# Preprocess generated TeX files
puts "Preprocess generated TeX files"
OverviewDoc_ProcessTex $TEXFILES $LATEXDIR $verboseMode
# Generate PDF files from
puts "Generate PDF files from"
foreach TEX $TEXFILES {
# Rewrite existing REFMAN.tex file...
set TEX [string range $TEX 0 [ expr "[string length $TEX] - 5"]]
@@ -548,6 +556,7 @@ proc OverviewDoc_Main { {docfiles {}} generatorMode docLabel verboseMode} {
puts "INFO: Generating PDF file from $TEX"
}
# ...and use it to generate PDF from TeX...
puts "execute $LATEXDIR/make$PREFIX"
set RESULT [catch {eval exec [auto_execok $LATEXDIR/make$PREFIX] > "$OUTDIR/pdflatex_out.log"} LaTeX_ERROR]
if {$RESULT != 0} {
if {[llength [split $LaTeX_ERROR "\n"]] > 1} {
@@ -563,6 +572,12 @@ proc OverviewDoc_Main { {docfiles {}} generatorMode docLabel verboseMode} {
if { [file exists $PDFDIR/$TEX.pdf] == 1 } {
file delete -force $PDFDIR/$TEX.pdf
}
if {![file exists "$LATEXDIR/refman.pdf"]} {
puts "file $LATEXDIR/refman.pdf doesn't exist"
return
}
file rename $LATEXDIR/refman.pdf "$PDFDIR/$TEX.pdf"
}
if {$verboseMode == "YES"} {