Documentation rework - part 2: Updates and corrections (#459)

* Conversion of existing documentation to LaTeX sources (#438) * initial work in converting existing documentation to LaTeX sources * added alert and code blocks * >> added cover logo >> further work in document structure * further work in demonstrating original document reproduction * improvements and additions to common packages * further document conversion work * added more packages and code keywords * further document conversion work * further document conversion work * further document conversion work * added "MESH code" language, for styling purposes * further document conversion work * further document conversion work * further document conversion work * Added advanced mesh rendering details and 2D graphics details. * Starting Atlantis Manual * further document conversion work * further document conversion work * Almost there... * further document conversion work * Atlantis Manual finished. * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * further document conversion work * initial work in updating cmake files * corrected silly typo and added missing argument * deleting old doc files * updating cmake file with deleted folder * another cmake update --------- Co-authored-by: GLS-SSV <[email protected]> Co-authored-by: jarmonik <[email protected]> Co-authored-by: jarmonik <[email protected]> * Updating and correcting the new documentation (#500) * initial work in updating and correcting documentation * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * more doc updates * Move gravity model info to its own section * more doc updates * updated DrawOrbits image * removed DrawOrbit image TODO --------- Co-authored-by: GLS-SSV <[email protected]> Co-authored-by: Matthew W Hume <[email protected]> --------- Co-authored-by: GLS-SSV <[email protected]> Co-authored-by: GLS-SSV <[email protected]> Co-authored-by: Matthew W Hume <[email protected]>
orbitersim · Dec 29, 2024 · 1149fe8 · 1149fe8
1 parent 99c8306
commit 1149fe8
Show file tree

Hide file tree

Showing 614 changed files with 15,246 additions and 4,087 deletions.
diff --git a/.gitignore b/.gitignore
@@ -25,3 +25,7 @@ Sound/XRSound/**/Release-with-OrbiterRelease/
 [Bb]uild/
 
 Extern/irrKlang
+
+Doc/**/*.log
+Doc/**/*.pdf
+Doc/**/*.gz
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -318,54 +318,6 @@ if (ORBITER_SANITIZER AND MSVC)
 	enable_sanitizer(${ORBITER_SANITIZER})
 endif()
 
-# For a given argument string template (odt_to_pdf_arglist) and source file name (infile)
-# return the explicit argument string (arglist), full source path (source_path) and full target path (target_path)
-# to invoke the ODT to PDF conversion tool
-
-function(odt_to_pdf_arglist infile arglist source_path target_path)
-	string(REPLACE
-		"<outdir>" "${CMAKE_CURRENT_BINARY_DIR}"
-		tmp1_string
-		${ODT_TO_PDF_FLAGS}
-	)
-	string(REPLACE
-		"<infile>" "${CMAKE_CURRENT_SOURCE_DIR}/${infile}.odt"
-		tmp2_string
-		${tmp1_string}
-	)
-	separate_arguments(odt_arg
-		WINDOWS_COMMAND
-		${tmp2_string}
-	)
-	set(${arglist} ${odt_arg} PARENT_SCOPE)
-	set(${source_path} "${CMAKE_CURRENT_SOURCE_DIR}/${infile}.odt" PARENT_SCOPE)
-	set(${target_path} "${CMAKE_CURRENT_BINARY_DIR}/${infile}.pdf" PARENT_SCOPE)
-endfunction()
-
-
-# For a given argument string template (odt_to_pdf_arglist) and source file name (infile)
-# return the explicit argument string (arglist), full source path (source_path) and full target path (target_path)
-# to invoke the DOC to PDF conversion tool
-
-function(doc_to_pdf_arglist infile arglist source_path target_path)
-	string(REPLACE
-		"<outdir>" "${CMAKE_CURRENT_BINARY_DIR}"
-		tmp1_string
-		${DOC_TO_PDF_FLAGS}
-	)
-	string(REPLACE
-		"<infile>" "${CMAKE_CURRENT_SOURCE_DIR}/${infile}.doc"
-		tmp2_string
-		${tmp1_string}
-	)
-	separate_arguments(doc_arg
-		WINDOWS_COMMAND
-		${tmp2_string}
-	)
-	set(${arglist} ${doc_arg} PARENT_SCOPE)
-	set(${source_path} "${CMAKE_CURRENT_SOURCE_DIR}/${infile}.doc" PARENT_SCOPE)
-	set(${target_path} "${CMAKE_CURRENT_BINARY_DIR}/${infile}.pdf" PARENT_SCOPE)
-endfunction()
 
 # Given a source directory (srcdir) and a target root directory (tgtroot),
 # generate a list of all files found in srcdir (srclist) and a list of output files

diff --git a/Config/transx.cfg b/Config/transx.cfg
diff --git a/Doc/CMakeLists.txt b/Doc/CMakeLists.txt
@@ -1,91 +1,3 @@
-# Orbiter.pdf ------------------------------------------------------------
-
-odt_to_pdf_arglist("Orbiter" arglist src out)
-add_custom_command(
-	OUTPUT ${out}
-	COMMAND ${ODT_TO_PDF_COMPILER} ${arglist}
-	DEPENDS ${src}
-	JOB_POOL soffice
-)
-add_custom_target(OrbiterDoc
-	DEPENDS ${out}
-)
-add_dependencies(${OrbiterTgt}
-	OrbiterDoc
-)
-set_target_properties(OrbiterDoc
-	PROPERTIES
-	FOLDER Doc
-)
-install(FILES ${out}
-	DESTINATION ${ORBITER_INSTALL_DOC_DIR}
-)
-
-# OrbiterConfig.pdf ------------------------------------------------------
-
-odt_to_pdf_arglist("OrbiterConfig" arglist src out)
-add_custom_command(
-	OUTPUT ${out}
-	COMMAND ${ODT_TO_PDF_COMPILER} ${arglist}
-	DEPENDS ${src}
-	JOB_POOL soffice
-)
-add_custom_target(OrbiterConfigDoc
-	DEPENDS ${out}
-)
-add_dependencies(${OrbiterTgt}
-	OrbiterConfigDoc
-)
-set_target_properties(OrbiterConfigDoc
-	PROPERTIES
-	FOLDER Doc
-)
-install(FILES ${out}
-	DESTINATION ${ORBITER_INSTALL_DOC_DIR}
-)
-
-# PlanetTextures.pdf -----------------------------------------------------
-
-odt_to_pdf_arglist("PlanetTextures" arglist src out)
-add_custom_command(
-	OUTPUT ${out}
-	COMMAND ${ODT_TO_PDF_COMPILER} ${arglist}
-	DEPENDS ${src}
-	JOB_POOL soffice
-)
-add_custom_target(PlanetTexturesDoc
-	DEPENDS ${out}
-)
-add_dependencies(${OrbiterTgt}
-	PlanetTexturesDoc
-)
-set_target_properties(PlanetTexturesDoc
-	PROPERTIES
-	FOLDER Doc
-)
-install(FILES ${out}
-	DESTINATION ${ORBITER_INSTALL_DOC_DIR}
-)
-
-# Credit.pdf -------------------------------------------------------------
-
-doc_to_pdf_arglist("Credit" arglist src out)
-add_custom_command(
-	OUTPUT ${out}
-	COMMAND ${DOC_TO_PDF_COMPILER} ${arglist}
-	DEPENDS ${src}
-	JOB_POOL soffice
-)
-add_custom_target(OrbiterCreditDoc
-	DEPENDS ${out}
-)
-add_dependencies(OrbiterDoc
-	OrbiterCreditDoc
-)
-install(FILES ${out}
-	DESTINATION ${ORBITER_INSTALL_DOC_DIR}
-)
-
-# Technotes --------------------------------------------------------------
-
-add_subdirectory(Technotes)
+add_subdirectory("Orbiter Developer Manual")
+add_subdirectory("Orbiter Technical Reference")
+add_subdirectory("Orbiter User Manual")
diff --git a/Doc/Credit.doc b/Doc/Credit.doc
diff --git a/Doc/D3D9Client.pdf b/Doc/D3D9Client.pdf
diff --git a/Doc/Orbiter Developer Manual/CMakeLists.txt b/Doc/Orbiter Developer Manual/CMakeLists.txt
@@ -0,0 +1,29 @@
+set(name "Orbiter Developer Manual")
+
+set(src_path ${CMAKE_CURRENT_SOURCE_DIR}/${name}.tex)
+set(out_path ${CMAKE_CURRENT_BINARY_DIR}/${name}.pdf)
+set(pdflatex_cmd ${PDFLATEX_COMPILER} --synctex=1 -output-directory=${CMAKE_CURRENT_BINARY_DIR} ${src_path})
+set(bibtex_cmd ${BIBTEX_COMPILER} ${CMAKE_CURRENT_BINARY_DIR}/${name})
+
+add_custom_command(
+	OUTPUT ${out_path}
+	COMMAND ${pdflatex_cmd}
+	COMMAND ${bibtex_cmd}
+	COMMAND ${pdflatex_cmd}
+	DEPENDS ${src_path}
+	WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+	JOB_POOL latex
+)
+add_custom_target(OrbiterDeveloperManual
+	DEPENDS ${out_path}
+)
+add_dependencies(${OrbiterTgt}
+	OrbiterDeveloperManual
+)
+set_target_properties(OrbiterDeveloperManual
+	PROPERTIES
+	FOLDER Doc
+)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${name}.pdf
+	DESTINATION ${ORBITER_INSTALL_ROOT_DIR}/Doc
+)