doc: add userguide into sw package

41d67584 · Benoit Rat · Alessandro Rubini · fc8ef509 · 41d67584 · 41d67584
Commit 41d67584 authored Mar 27, 2013 by Benoit Rat Committed by Alessandro Rubini Apr 04, 2013
11 changed files
--- a/doc/user_guide/.gitignore
+++ b/doc/user_guide/.gitignore
+~
+pdf/
+tex/
+*.aux
+*.log
+*.out
+*.pdf
+*.tex
+*.toc
+
--- a/doc/user_guide/Makefile
+++ b/doc/user_guide/Makefile
+########################################################################
+## Makefile to generate multiple document from the same markdown file
+## using  pandoc software:
+##
+## References:
+##
+## Authors: 
+##	- Benoit Rat (Seven Solutions, www.sevensols.com)
+##
+## GNU Lesser General Public License Usage
+## This file may be used under the terms of the GNU Lesser
+## General Public License version 2.1 as published by the Free Software
+## Foundation and appearing in the file LICENSE.LGPL included in the
+## packaging of this file.  Please review the following information to
+## ensure the GNU Lesser General Public License version 2.1 requirements
+## will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+########################################################################
+
+
+## Obtaining the proper file
+SRC=$(wildcard *.md)
+PDF=$(addprefix pdf/, $(SRC:.md=.pdf))
+TEX=$(SRC:.md=.tex)
+DOC=$(SRC:.md=.doc)
+
+## Pandoc arguments
+OPTIONS=-f markdown --toc --number-sections --smart
+TEMPLATE=pandoc.latex 
+
+
+ifneq "$(TEMPLATE)" ""
+TEMPLATEARG=--template=$(TEMPLATE)
+endif
+
+## Obtain the version ($ is replaced by $$)
+VERSION = $(shell git describe --always --dirty=+ | sed  's;^.*-\([v0-9\.]*\)\([a-z0-9\-+]*\)$$;\1\2;' )
+DATE	= $(shell date +"%d %b. %Y")
+
+#--highlight-style=pygments (the default), kate, monochrome, espresso, haddock, and tango
+#-V highlight-bg=true
+
+## Main targets
+all: $(PDF)
+tex: $(TEX)
+doc: $(DOC)
+pdf: $(PDF)
+
+## Special targets to create directory	
+DIR_%:
+	mkdir -p $(subst DIR_,,$@)	
+
+pdf/%.pdf: %.md Makefile $(TEMPLATE) DIR_pdf
+	pandoc $(OPTIONS) --latex-engine=xelatex  --listings --highlight-style=haddock $(TEMPLATEARG) \
+-V lang=english -V fontsize=11pt -V documentclass=article -V bg-color=238,245,240 -V date="$(DATE) - $(VERSION)" -o $@ $<
+
+%.tex: %.md Makefile $(TEMPLATE) 
+	@echo "$(VERSION) @ $(notdir $@) $@ < $< ^ $^"
+	pandoc $(OPTIONS) --listings --highlight-style=haddock $(TEMPLATEARG) \
+-V lang=english  -V  fontsize=11pt -V documentclass=article -V bg-color=238,245,240 -o $@ $<
+
+
+%.doc: %.md Makefile $(TEMPLATE) 
+	@echo "$(VERSION) @ $(notdir $@) $@ < $< ^ $^"
+	pandoc $(OPTIONS) --listings \
+-V lang=english  -V  fontsize=11pt -V documentclass=article -V bg-color=238,245,240 -o $@ $<
+
+install: $(PDF) 
+	mkdir -p ../pdf
+	cp  $< ../$(subst .pdf,-$(VERSION).pdf,$<)
+
+.PHONY: clean
+
+clean:
+	rm -f pdf/*.pdf *~ *.tex *.log
+
+	
+	
--- a/doc/user_guide/back_panel.png
+++ b/doc/user_guide/back_panel.png
--- a/doc/user_guide/front_panel.png
+++ b/doc/user_guide/front_panel.png
--- a/doc/user_guide/logo.png
+++ b/doc/user_guide/logo.png
--- a/doc/user_guide/pandoc.latex
+++ b/doc/user_guide/pandoc.latex
--- a/doc/user_guide/putty-ACM0.png
+++ b/doc/user_guide/putty-ACM0.png
--- a/doc/user_guide/putty-SSH.png
+++ b/doc/user_guide/putty-SSH.png
--- a/doc/user_guide/trash.jpg
+++ b/doc/user_guide/trash.jpg
--- a/doc/user_guide/wr_network2.jpg
+++ b/doc/user_guide/wr_network2.jpg
--- a/doc/user_guide/wrs-user_guide.md
+++ b/doc/user_guide/wrs-user_guide.md