From 0798fd2d94f204057244ce795ebb57f49c1c5cef Mon Sep 17 00:00:00 2001 From: Jose Maria Casanova Crespo Date: Mon, 25 Jan 2010 19:54:01 +0100 Subject: [PATCH] ItEr45S02AnaliseItEr44S02: Basic structure for development guide and rst infraestructure --- .../technical/guia-desenvolvemento/Makefile | 153 ++++ .../technical/guia-desenvolvemento/docinfo | 8 + .../guia-arquitectura.rst | 3 + .../guia-desenvolvemento-caso-uso.rst | 2 + .../guia-desenvolvemento-git.rst | 2 + .../guia-desenvolvemento.rst | 2 + .../guia-desenvolvemento/guia-instalacion.rst | 2 + .../guia-integracion-terceiros.rst | 35 +- .../guia-desenvolvemento/igaliabk.cls | 715 ++++++++++++++++++ .../images}/costcategories.png | Bin .../images}/criterions.png | Bin .../images}/labels.png | Bin .../images}/materials.png | Bin .../images}/orders.png | Bin .../images}/resources.png | Bin .../images}/typeofworkhours.png | Bin .../images}/workedhours.png | Bin .../images}/workreports.png | Bin .../technical/guia-desenvolvemento/lsr.css | 251 ++++++ doc/src/technical/guia-desenvolvemento/parts | 18 + 20 files changed, 1175 insertions(+), 16 deletions(-) create mode 100644 doc/src/technical/guia-desenvolvemento/Makefile create mode 100644 doc/src/technical/guia-desenvolvemento/docinfo create mode 100644 doc/src/technical/guia-desenvolvemento/guia-arquitectura.rst create mode 100644 doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-caso-uso.rst create mode 100644 doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-git.rst create mode 100644 doc/src/technical/guia-desenvolvemento/guia-desenvolvemento.rst create mode 100644 doc/src/technical/guia-desenvolvemento/guia-instalacion.rst rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento}/guia-integracion-terceiros.rst (99%) create mode 100644 doc/src/technical/guia-desenvolvemento/igaliabk.cls rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento/images}/costcategories.png (100%) rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento/images}/criterions.png (100%) rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento/images}/labels.png (100%) rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento/images}/materials.png (100%) rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento/images}/orders.png (100%) rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento/images}/resources.png (100%) rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento/images}/typeofworkhours.png (100%) rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento/images}/workedhours.png (100%) rename doc/src/technical/{guia-integracion-terceiros => guia-desenvolvemento/images}/workreports.png (100%) create mode 100644 doc/src/technical/guia-desenvolvemento/lsr.css create mode 100644 doc/src/technical/guia-desenvolvemento/parts diff --git a/doc/src/technical/guia-desenvolvemento/Makefile b/doc/src/technical/guia-desenvolvemento/Makefile new file mode 100644 index 000000000..8008535d0 --- /dev/null +++ b/doc/src/technical/guia-desenvolvemento/Makefile @@ -0,0 +1,153 @@ +# +# Makefile +# Adrian Perez, 2009-05-15 11:20 +# + +RST_HTML_FLAGS = --link-stylesheet --stylesheet-path=html/lsr.css +RST_TEX_FLAGS = --documentclass=igaliabk --font-encoding=OT1 --output-encoding-error-handler backslashreplace +OUTPUT_BASE = output + +rst_srcs := $(filter-out index.rst,$(wildcard *.rst)) +html_pages := $(patsubst %.rst,html/%.html,$(rst_srcs)) html/index.html + +svg_images := $(wildcard images/*.svg) +png_images := $(patsubst %.svg,%.png,$(svg_images)) $(wildcard images/*.png) + +utildir := ../../../tools/ + +# Main targets +# +all: html pdf +pdf: pdf/$(OUTPUT_BASE).pdf +ebook: pdf/$(OUTPUT_BASE).ebook.pdf +html: $(html_pages) +png: $(png_images) + +.PHONY: html pdf ebook png + +### Xavi + +all_img := $(wildcard images/*) +build_images := + +src_images := $(wildcard images/*) +html_images := $(patsubst %,html/%,$(src_images)) +pdf_images := $(patsubst %,pdf/%,$(src_images)) + +$(html_images): html/images/%: images/% + $P copy-img $@ + $Q mkdir -p $(@D) + $Q cp $< $@ + +$(pdf_images): pdf/images/%: images/% + $P copy-img $@ + $Q mkdir -p $(@D) + $Q cp $< $@ + +$(main_pdf): $(pdf_imges) + + + +### End Xavi + + +# Cleanup targets +# +clean: + $P clean pdf + $Q $(RM) -r pdf/ + $P clean html + $Q $(RM) -r html/ + $Q $(RM) index.rst + +# Copy CSS file +# +html/lsr.css: lsr.css + $P copy $@ + $Q mkdir -p $(@D) + $Q cp $< $@ + +$(html_pages): html/lsr.css $(html_images) + + +# Top-level RST creation for the PDF +# +pdf/$(OUTPUT_BASE).rst: $(rst_srcs) docinfo + $P toplevel $@ + $Q mkdir -p $(@D) + $Q $(utildir)/doctool toplevel --info=docinfo $(rst_srcs) > $@ + +pdf/$(OUTPUT_BASE).pdf pdf/$(OUTPUT_BASE).ebook.pdf: $(png_images) + +# Index page creation for the HTML output +# +index.rst: $(rst_srcs) docinfo + $P htmlindex $@ + $Q mkdir -p $(@D) + $Q $(utildir)/doctool htmlindex --info=docinfo $(rst_srcs) > $@ + + +# Implicit rules +# +html/%.html: %.rst + $P rst2html $@ + $Q mkdir -p $(@D) + $Q $(utildir)/doctool rst2html $(RST_HTML_FLAGS) $< $@ + +%.tex: %.rst + $P rst2latex $@ + $Q mkdir -p $(@D) + $Q $(utildir)/doctool rst2latex $(RST_TEX_FLAGS) $< $@ + +%.ebook.tex: %.rst + $P rst2ebook $@ + $Q mkdir -p $(@D) + $Q $(utildir)/doctool rst2ebook $(RST_TEX_FLAGS) $< $@ + +%.pdf: %.tex + $P pdflatex $@ + $Q cd $(@D) && TEXINPUTS=.:$(CURDIR): pdflatex $(PDFLATEX_FLAGS) $(CURDIR)/$< + $Q cd $(@D) && TEXINPUTS=.:$(CURDIR): pdflatex $(PDFLATEX_FLAGS) $(CURDIR)/$< + +%.trim.png: %.svg + $P svg2png $@ + $Q inkscape --without-gui --export-png=$@ --export-area-canvas --export-dpi=150 $< + +%.png: %.trim.png + $P png-trim $@ + $Q convert -trim $< $@ + +# Avoid removing intermediate .tex files and similar things. +# +.SECONDARY: + +# Control operation verboseness +# +ifeq ($(origin V),command line) + verbose := $(V) +endif +ifndef verbose + verbose := 0 +endif + +ifeq ($(verbose),0) + P = @printf ' * %-10s %s\n' + Q = @ + PDFLATEX_FLAGS += -interaction batchmode +else + P = @: +endif + +# Check for the U= command line argument +# +ifeq ($(origin U),command line) + utildir := $(U) +endif +ifndef utildir + utildir := $(CURDIR) +endif + + +# vim:ft=make +# + diff --git a/doc/src/technical/guia-desenvolvemento/docinfo b/doc/src/technical/guia-desenvolvemento/docinfo new file mode 100644 index 000000000..99e0ace1b --- /dev/null +++ b/doc/src/technical/guia-desenvolvemento/docinfo @@ -0,0 +1,8 @@ +################################## +NavalPlan: Guía de desenvolvemento +################################## + +.. image:: images/logo1.gif + :align: left + +TODO: Esta é a guia de desenvolvemnto de NavalPlan \ No newline at end of file diff --git a/doc/src/technical/guia-desenvolvemento/guia-arquitectura.rst b/doc/src/technical/guia-desenvolvemento/guia-arquitectura.rst new file mode 100644 index 000000000..5c891243a --- /dev/null +++ b/doc/src/technical/guia-desenvolvemento/guia-arquitectura.rst @@ -0,0 +1,3 @@ + +Guía de Arquitectura +##################### diff --git a/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-caso-uso.rst b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-caso-uso.rst new file mode 100644 index 000000000..0702ad7ac --- /dev/null +++ b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-caso-uso.rst @@ -0,0 +1,2 @@ +Guia de desenvolvemento dun caso de uso +####################################### diff --git a/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-git.rst b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-git.rst new file mode 100644 index 000000000..312e780b6 --- /dev/null +++ b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento-git.rst @@ -0,0 +1,2 @@ +Guía de Desenvolvemento con GIT +############################### diff --git a/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento.rst b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento.rst new file mode 100644 index 000000000..6c8e02e35 --- /dev/null +++ b/doc/src/technical/guia-desenvolvemento/guia-desenvolvemento.rst @@ -0,0 +1,2 @@ +Guía de Desenvolvemento +####################### diff --git a/doc/src/technical/guia-desenvolvemento/guia-instalacion.rst b/doc/src/technical/guia-desenvolvemento/guia-instalacion.rst new file mode 100644 index 000000000..aedbba190 --- /dev/null +++ b/doc/src/technical/guia-desenvolvemento/guia-instalacion.rst @@ -0,0 +1,2 @@ +Guía de Instalación +################### diff --git a/doc/src/technical/guia-integracion-terceiros/guia-integracion-terceiros.rst b/doc/src/technical/guia-desenvolvemento/guia-integracion-terceiros.rst similarity index 99% rename from doc/src/technical/guia-integracion-terceiros/guia-integracion-terceiros.rst rename to doc/src/technical/guia-desenvolvemento/guia-integracion-terceiros.rst index e73a3d98c..5afcbe959 100644 --- a/doc/src/technical/guia-integracion-terceiros/guia-integracion-terceiros.rst +++ b/doc/src/technical/guia-desenvolvemento/guia-integracion-terceiros.rst @@ -1,10 +1,12 @@ + NavalPlan: Guía de integración -============================== +############################## A guía de integración de NavalPlan detalla as posibilidades existentes para a integración entre aplicacións co software NavalPlan. As funcionalidades de integración da ferramenta para a Xestión da Producción permitirán a compartición de datos entre as distintas ferramentas existentes en cada empresa. NavalPlan define unha serie de formatos de intercambio de información empregando a sintaxe XML. A descrición das interfaces e formatos de intercambio son totalmente abertos e está dispoñible a súa implementación para incorporar novas posibilidades de integración se fose necesario. + Visión Global ============= @@ -301,6 +303,7 @@ Xa que para os servizos web de NavalPlan van estar dispoñibles os XML Schema do Tamén se implementará a través de CXF unha validación do XML entrante no corpo das mensaxes HTTP de invocación dos servizos web por parte dos clientes. Por tanto, se validará se o XML contra o esquema XML e se non é correcto mandarase unha mensaxe de resposta HTTP con código de estado 400 e corpo baleiro. + Fluxos de integración ===================== @@ -339,7 +342,7 @@ Postcondicións * se un material cambia de categoría modificarase a categoría a que pertence o material. Clases involucradas en NavalPlan - .. image:: materials.png + .. image:: images/materials.png :width: 300 :alt: Diagrama de Clases do dominio de Materiais en NavalPlan @@ -411,7 +414,7 @@ Postcondicións * os seus campos propios serán actualizados coa nova información. Clases involucradas en NavalPlan - .. image:: labels.png + .. image:: images/labels.png :width: 200 :alt: Diagrama de Clases do dominio de Etiquetas en NavalPlan @@ -475,7 +478,7 @@ Postcondicións * se un criterio non aparece nunha nova importación non se realizará ningún cambio xa que non se realizan borrados. So se realizan actualizacións e marcados coma non activados. Clases involucradas en NavalPlan - .. image:: criterions.png + .. image:: images/criterions.png :width: 350 :alt: Diagrama de Clases do dominio de Criterios en NavalPlan @@ -564,7 +567,7 @@ Postcondicións * As instancias que existían previamente no sistema verán actualizada a súa información. Clases involucradas en NavalPlan - .. image:: typeofworkhours.png + .. image:: images/typeofworkhours.png :width: 150 :alt: Diagrama de Clases do dominio de Tipos de Horas en NavalPlan @@ -610,7 +613,7 @@ Postcondicións * As instancias que xa existían previamente no sistema verán actualizada a súa información. Clases involucradas en NavalPlan - .. image:: costcategories.png + .. image:: images/costcategories.png :width: 150 :alt: Diagrama de Clases do dominio de Categorías de Coste en NavalPlan @@ -673,7 +676,7 @@ Postcondicións * as relacións con novos criterios e categorías de custo serán incorporadas. Nunca se borrarán categorías nin criterios se non son incorporados na aplicación xa que poden ter sido dados de alta a través da interface web de NavalPlan. En caso de incoherencia nunca se borrará a información de NavalPlan e reportarase a existencia de inconsistencias para que sexan emendadas. Clases involucradas en NavalPlan - .. image:: resources.png + .. image:: images/resources.png :width: 350 :alt: Diagrama de Clases do dominio de Recursos en NavalPlan @@ -800,7 +803,7 @@ Postcondicións * Os partes xa existentes verán actualizada a súa información. Clases involucradas en NavalPlan - .. image:: workreports.png + .. image:: images/workreports.png :width: 400 :alt: Diagrama de Clases do dominio de Partes de Traballo en NavalPlan @@ -838,9 +841,9 @@ Exemplo de ficheiro de importación: - + - + @@ -880,7 +883,7 @@ Postcondicións * Actualizarase a información dos elementos do pedido. Clases involucradas en NavalPlan - .. image:: orders.png + .. image:: images/orders.png :width: 350 :alt: Diagrama de Clases do dominio de Pedidos en NavalPlan @@ -896,7 +899,7 @@ Exemplo de ficheiro de importación :: - +