a_adli/research_project_integration_documentation
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add examples for inserting codes in the document (template file)

Browse Source
This commit is contained in:
Alireza Adli 2024-01-24 11:13:28 -05:00
parent 16c0c55b2e
commit 1eb0ac69b0
6 changed files with 39 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
template/report.aux
View File

@ -20,12 +20,12 @@
\@writefile{toc}{\contentsline {section}{\numberline {2}The Project Structure}{3}{section.2}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}ClassName1}{3}{subsection.2.1}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}ClassName2}{3}{subsection.2.2}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {2.3}ClassWorkflow}{3}{subsection.2.3}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {3}3rd Party Software}{3}{section.3}\protected@file@percent }
\@writefile{toc}{\contentsline {subsection}{\numberline {2.3}ClassWorkflow}{4}{subsection.2.3}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {3}3rd Party Software}{4}{section.3}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {4}Input Data}{4}{section.4}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {5}Constants}{4}{section.5}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6}Output Data}{4}{section.6}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {5}Constants}{5}{section.5}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {6}Output Data}{5}{section.6}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {7}Limitations}{5}{section.7}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {8}Technical Performance}{5}{section.8}\protected@file@percent }
\@writefile{toc}{\contentsline {section}{\numberline {9}More sections...}{5}{section.9}\protected@file@percent }
\gdef \@abspage@last{6}
\@writefile{toc}{\contentsline {section}{\numberline {9}More sections...}{6}{section.9}\protected@file@percent }
\gdef \@abspage@last{7}

31
template/report.log
View File

@ -1,4 +1,4 @@
This is pdfTeX, Version 3.141592653-2.6-1.40.24 (MiKTeX 21.12) (preloaded format=pdflatex 2022.2.20) 24 JAN 2024 10:49
This is pdfTeX, Version 3.141592653-2.6-1.40.24 (MiKTeX 21.12) (preloaded format=pdflatex 2022.2.20) 24 JAN 2024 11:12
entering extended mode
restricted \write18 enabled.
%&-line parsing enabled.
@ -621,7 +621,9 @@ LaTeX Font Info: Trying to load font information for TS1+ptm on input line 1
(C:\Users\a_adli\AppData\Local\Programs\MiKTeX\tex/latex/psnfss\ts1ptm.fd
File: ts1ptm.fd 2001/06/04 font definitions for TS1/ptm.
)
[3] [4] [5] (report.aux)
(C:\Users\a_adli\AppData\Local\Programs\MiKTeX\tex/latex/listings\lstlang1.sty
File: lstlang1.sty 2020/03/24 1.8d listings language file
) [3] [4] [5] [6] (report.aux)
LaTeX Font Warning: Size substitutions with differences
(Font) up to 0.4641pt have occurred.
@ -633,21 +635,22 @@ Package rerunfilecheck Info: File `report.out' has not changed.
(rerunfilecheck) Checksum: 6CC62A7EA35E7EBE16AA99387B1F67EE;1423.
)
Here is how much of TeX's memory you used:
16270 strings out of 478659
317259 string characters out of 2845446
579929 words of memory out of 3000000
34167 multiletter control sequences out of 15000+600000
421055 words of font info for 59 fonts, out of 8000000 for 9000
16709 strings out of 478659
321287 string characters out of 2845446
771825 words of memory out of 3000000
34592 multiletter control sequences out of 15000+600000
425069 words of font info for 66 fonts, out of 8000000 for 9000
1141 hyphenation exceptions out of 8191
70i,6n,79p,440b,830s stack positions out of 5000i,500n,10000p,200000b,80000s
70i,6n,79p,440b,1349s stack positions out of 5000i,500n,10000p,200000b,80000s
{C:/Users/a_adli/AppData/Local/Programs/MiKTeX/fonts/enc/dvips/base/8r.enc}<C
:/Users/a_adli/AppData/Local/Programs/MiKTeX/fonts/type1/public/amsfonts/cm/cmr
9.pfb><C:/Users/a_adli/AppData/Local/Programs/MiKTeX/fonts/type1/urw/times/utmb
8a.pfb><C:/Users/a_adli/AppData/Local/Programs/MiKTeX/fonts/type1/urw/times/utm
r8a.pfb>
Output written on report.pdf (6 pages, 157892 bytes).
9.pfb><C:/Users/a_adli/AppData/Local/Programs/MiKTeX/fonts/type1/public/amsfont
s/cm/cmtt10.pfb><C:/Users/a_adli/AppData/Local/Programs/MiKTeX/fonts/type1/urw/
times/utmb8a.pfb><C:/Users/a_adli/AppData/Local/Programs/MiKTeX/fonts/type1/urw
/times/utmr8a.pfb>
Output written on report.pdf (7 pages, 174206 bytes).
PDF statistics:
120 PDF objects out of 1000 (max. 8388607)
19 named destinations out of 1000 (max. 500000)
137 PDF objects out of 1000 (max. 8388607)
25 named destinations out of 1000 (max. 500000)
102 words of extra memory for PDF output out of 10000 (max. 10000000)

BIN
template/report.pdf
View File

Binary file not shown.

BIN
template/report.synctex.gz
View File

Binary file not shown.

11
template/report.tex
View File

@ -153,6 +153,17 @@ For detailed technical information of the project read [Researcher's name] [degr
\subsection{ClassName1}
Subsection titling the names of classes/coding files if you would like to provide more details.
In the \LaTeX file of this document, please locate the code for inserting programming snippets, as demonstrated below:
\begin{code}
import math
def circle_square(radius):
return math.pi * radius ** 2
print(circle_square(3))
\end{code}
(Select the programming language and configure color settings from lines 17-30 of the \LaTeX file for this document).
\subsection{ClassName2}
Include an example of instantiating the class for clarity.

10
template/report.toc
View File

@ -2,11 +2,11 @@
\contentsline {section}{\numberline {2}The Project Structure}{3}{section.2}%
\contentsline {subsection}{\numberline {2.1}ClassName1}{3}{subsection.2.1}%
\contentsline {subsection}{\numberline {2.2}ClassName2}{3}{subsection.2.2}%
\contentsline {subsection}{\numberline {2.3}ClassWorkflow}{3}{subsection.2.3}%
\contentsline {section}{\numberline {3}3rd Party Software}{3}{section.3}%
\contentsline {subsection}{\numberline {2.3}ClassWorkflow}{4}{subsection.2.3}%
\contentsline {section}{\numberline {3}3rd Party Software}{4}{section.3}%
\contentsline {section}{\numberline {4}Input Data}{4}{section.4}%
\contentsline {section}{\numberline {5}Constants}{4}{section.5}%
\contentsline {section}{\numberline {6}Output Data}{4}{section.6}%
\contentsline {section}{\numberline {5}Constants}{5}{section.5}%
\contentsline {section}{\numberline {6}Output Data}{5}{section.6}%
\contentsline {section}{\numberline {7}Limitations}{5}{section.7}%
\contentsline {section}{\numberline {8}Technical Performance}{5}{section.8}%
\contentsline {section}{\numberline {9}More sections...}{5}{section.9}%
\contentsline {section}{\numberline {9}More sections...}{6}{section.9}%