IDE Scripts

Intro

Scripts used in the IDE implementation. This is separated into two tasks with supporting documentation and compilation. Some scripts work on updating the html display. Others command line tools, often used in work flow.

The aim of this document is to document IDE script development, and is part of my Workspace Scripts.

Simply put the aim is to make the project accessible without even doing compilation. So as the developer I can approach the workspace and gleam its state.

The scripts for the ide are in the ide directory. ide/ide.sh Builds/sources in script files for the ide and is the main or central point for the ide.

• ide/docdoxygen.sh
• ide/docmakefile.sh Updates Makefile.html. Depends on Doxygen being run.
  $ Makefilehtml <module> inside module directory.
  $ projdocmakefile generates all modules makefile html doc.
• ide/docsourcetable.sh
• ide/exportsource.sh
• ide/ide.sh
• ide/MakefileUpdate.sh
• ide/Misc.pm
• ide/misc.sh
• ide/projlib.sh
• [deprecated] ide/ProjReport.pm
• [deprecated] ide/ReportHtml.pm
• ide/svnfunctions.sh
• ide/test01.pl
• ide/test02.pl
• ide/test03.pl
• ide/testscripts.sh
• [deprecated] ide/update_report_html.pl

Projects Sourcetable Update

The projects doc is independent of the CI and uses Doxygen[Doxyfile] to generate a detailed source tree indexing.

• Code base on Linux box. Doxygen installed.
• $ projdocdoxygen[docdoxygen.sh] generates the Doxygen documentation and takes a while. Graphviz ($ dot) for graphics needs to be installed.
• $ htmlpngreduction[docdoxygen.sh] to reduce Doxygen images.
• $ projdocsourcetable[docsourcetable.sh] - edits proj/xxx/doc.html putting in hyper links to source files, Makefile and Doxygen class documentation.

Issues

• Script updates totally unclear.
  Document the script running to update the projects documentation.
  Investigate the out of control situation, and place recommendations in the roadmap.
  e.g. CI applied to the html files to check html validity.
• Reference in docsourcetable.sh needs investigating.
• Show/hide parts of html source code in doc.html/xml project files.
• raw access to code needed
  $ ls *.cpp *.h | sort
  create hyper links
• Display current command line program options in doc.html/xml project files.

  $ ./main
  Test programs in simplextess workspace.
  $./main prog=1  Compiling and printing simplexD2tessindexed.
  $./main prog=2  Reading from a file a simplexD2tessindexed.
  $./main prog=3  Change the winding of a simplexD2tessindexed to anticlockwise.
  $./main prog=4 file=<tessD2003.txt>   Application to displays a 2D triangle tessellation from indexed triangles.
  $./main prog=5  Reading a simplexD1list from a vector.
  $./main prog=6  Test simplexD1listlinked::serializeInverse
  $./main prog=7  Given a list of lines/segments link them up.
  $./main prog=10  From vectors construct a simplexD1tessindexed tess and print it.
  $./main prog=11  Print screen test simplexD1indexed serialization.
  $./main prog=12  Unit test simplexD1indexed serialization.
  $./main prog=15 file=<tessD1001.txt> Application to displays a line tessellation from indexed lines.
  

  Special characters < > need translation.
  put in another file and hyper link. A simple .txt file would be enough.
  Optional as there are projects that this is unwanted. e.g. Graphics