search

afry-south / dragonfly-fcb

ÅF Dragonfly Quadrotor UAV Project
Other
7 stars 3 forks source link

LaTeX documentation #42

Open stenbergd opened 9 years ago

stenbergd commented 9 years ago

Setup a LaTeX template and start entering some topics for FCB documentation

adam-at-epsilon commented 9 years ago

I suggest that we use Dia for generating UML diagrams, the we can export diagrams as .png and use them in the document.

We also need to keep the .dia files in the documentation tree so that sketches and diagrams can easily be edited in the future.

Dia is free and works both in Windows- and Linuxverse.

stenbergd commented 9 years ago

I've set up a LaTeX template (.tex file) in the ONE project site documents directory (/Embedded/Flight Control Board).

There are some built-in UML generators for LaTeX - could be an option as well.

adam-at-epsilon commented 9 years ago

I'll evaluate MetaUML a little.

We'll only need class diagrams state diagrams sequence diagrams

http://metauml.sourceforge.net/old/index.html

http://www.cs.bgu.ac.il/~gwiener/software-engineering/how-to-embed-uml-in-latex/ (involves doing the uml diagram compilation "on the side", not integrated)

Stackexchange: pgf-umlcd (class & sequence diagrams, but not state diagrams) http://tex.stackexchange.com/questions/875/typsetting-uml-class-diagrams

Note to Adam: evaluate this one: http://perso.ensta-paristech.fr/~kielbasi/tikzuml/index.php?lang=en&id=doc#t-1

http://soerenbnoergaard.blogspot.se/2012/02/using-tikz-uml-to-create-uml-diagrams.html

stenbergd commented 9 years ago

Ok, the LaTeX documentation is now readded to the master branch (removed from ONE project site)

adam-at-epsilon commented 9 years ago

the report template is now added to the

https://github.com/afconsult-south/dragonfly doc directory under the name dragonfly-report-template.tex and I think the "master" template should live in that project.

The hyperref package has been added to the template in the /dragonfly repo so that the TOC titles are clickable.