- Se limpia y ordena la salida de latex.

- Se agrega un script para generar automaticamente la limpieza para construir el
  manual de administracion y de desarrollo.
- Se agregan archivos de soporte para el script para pisar los indices generados
  por el Doxygen y cambiar los titulo.
- Se agrega un 'bug' en una referencia de la documentacion del Constructor.
- Se actualiza la TODO list.

diff --git a/Constructor/include/documentacion.h b/Constructor/include/documentacion.h
index cf42e635549be05f0f429ccf886b6f3b73c87461..2d0da50acd1318ddb15351507f1e0df7ba0b5d32 100644 (file)
--- a/Constructor/include/documentacion.h
+++ b/Constructor/include/documentacion.h
@@ -20,7 +20,7 @@
                \verbinclude codo.xml
        - Empalme (\ref Union "unión" o \ref Splitter "división"):
                \verbinclude empalme.xml
-       - \ref Pump Bomba:
+       - \ref Pump "Bomba":
                \verbinclude bomba.xml
        - \ref Cistern "Tanque":
                \verbinclude tanque.xml

diff --git a/Doxyfile.informe b/Doxyfile.informe
index 9fbe0afef06886d58012e9ddbd06a2194e28bb34..f26a1c59ddb71dfa47709d132ecde66bce8cf2bc 100644 (file)
--- a/Doxyfile.informe
+++ b/Doxyfile.informe
@@ -125,7 +125,7 @@ TREEVIEW_WIDTH         = 250
 # configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
 GENERATE_LATEX         = YES
-LATEX_OUTPUT           = latex
+LATEX_OUTPUT           = devel
 LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
 COMPACT_LATEX          = NO

diff --git a/TODO b/TODO
index 2c2b36bf1035de3194e64b5960867df50134b69a..07c6dabb4b43eb049c9c43698ba20e8f1bee21a9 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,7 +1,6 @@
 $Id$
 
 1) Terminar manuales.
-  a) (luca) Limpiar un poco más el manual de desarrollo/administrador imprimible.
   b) Hacer manual del proyecto.
     i)   Poner falencias:
          - Lo de los sockets bloqueantes y conexion suicida.
@@ -20,7 +19,7 @@ $Id$
   c) Programas de prueba (calculo que lo que esta en tests/).
   d) Archivos de prueba.
 
-3) Armar CD.
+3) (luca) Armar CD.
   a) Generar documentacion en linea (ejecutar doxygen).
   b) Meterle los manuales en PDF y en lo posible en HTML tambien.
   c) Poner tarball con la ultima version de PlaQui.

diff --git a/docs/api/doxygen_admin.sty b/docs/api/doxygen_admin.sty
new file mode 100644 (file)
index 0000000..7642124
--- /dev/null
+++ b/docs/api/doxygen_admin.sty
@@ -0,0 +1,64 @@
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{doxygen}
+\RequirePackage{calc}
+\RequirePackage{array}
+\pagestyle{fancyplain}
+\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}}
+\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
+\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}}
+\lhead[\fancyplain{}{\bfseries\thepage}]
+        {\fancyplain{}{\bfseries\rightmark}}
+\rhead[\fancyplain{}{\bfseries\leftmark}]
+        {\fancyplain{}{\bfseries\thepage}}
+\rfoot[\fancyplain{}{\bfseries\scriptsize PlaQui 1.0 }]{}
+\lfoot[]{\fancyplain{}{\bfseries\scriptsize Manual de Administraci\'{o}n }}
+\cfoot{}
+\newenvironment{CompactList}
+{\begin{list}{}{
+  \setlength{\leftmargin}{0.5cm}
+  \setlength{\itemsep}{0pt}
+  \setlength{\parsep}{0pt}
+  \setlength{\topsep}{0pt}
+  \renewcommand{\makelabel}{}}}
+{\end{list}}
+\newenvironment{CompactItemize}
+{
+  \begin{itemize}
+  \setlength{\itemsep}{-3pt}
+  \setlength{\parsep}{0pt}
+  \setlength{\topsep}{0pt}
+  \setlength{\partopsep}{0pt}
+}
+{\end{itemize}}
+\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
+\newlength{\tmplength}
+\newenvironment{TabularC}[1]
+{
+\setlength{\tmplength}
+     {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
+      \par\begin{tabular*}{\linewidth}
+             {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
+}
+{\end{tabular*}\par}
+\newcommand{\entrylabel}[1]{
+   {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\\}}}
+\newenvironment{Desc}
+{\begin{list}{}
+  {
+    \settowidth{\labelwidth}{40pt}
+    \setlength{\leftmargin}{\labelwidth}
+    \setlength{\parsep}{0pt}
+    \setlength{\itemsep}{-4pt}
+    \renewcommand{\makelabel}{\entrylabel}
+  }
+}
+{\end{list}}
+\newenvironment{Indent}
+  {\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
+      \item[]\ignorespaces}
+  {\unskip\end{list}}
+\setlength{\parindent}{0cm}
+\setlength{\parskip}{0.2cm}
+\addtocounter{secnumdepth}{1}
+\sloppy
+\usepackage[T1]{fontenc}

diff --git a/docs/api/doxygen_devel.sty b/docs/api/doxygen_devel.sty
new file mode 100644 (file)
index 0000000..7642124
--- /dev/null
+++ b/docs/api/doxygen_devel.sty
@@ -0,0 +1,64 @@
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{doxygen}
+\RequirePackage{calc}
+\RequirePackage{array}
+\pagestyle{fancyplain}
+\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}}
+\renewcommand{\chaptermark}[1]{\markboth{#1}{}}
+\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}}
+\lhead[\fancyplain{}{\bfseries\thepage}]
+        {\fancyplain{}{\bfseries\rightmark}}
+\rhead[\fancyplain{}{\bfseries\leftmark}]
+        {\fancyplain{}{\bfseries\thepage}}
+\rfoot[\fancyplain{}{\bfseries\scriptsize PlaQui 1.0 }]{}
+\lfoot[]{\fancyplain{}{\bfseries\scriptsize Manual de Administraci\'{o}n }}
+\cfoot{}
+\newenvironment{CompactList}
+{\begin{list}{}{
+  \setlength{\leftmargin}{0.5cm}
+  \setlength{\itemsep}{0pt}
+  \setlength{\parsep}{0pt}
+  \setlength{\topsep}{0pt}
+  \renewcommand{\makelabel}{}}}
+{\end{list}}
+\newenvironment{CompactItemize}
+{
+  \begin{itemize}
+  \setlength{\itemsep}{-3pt}
+  \setlength{\parsep}{0pt}
+  \setlength{\topsep}{0pt}
+  \setlength{\partopsep}{0pt}
+}
+{\end{itemize}}
+\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp}
+\newlength{\tmplength}
+\newenvironment{TabularC}[1]
+{
+\setlength{\tmplength}
+     {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)}
+      \par\begin{tabular*}{\linewidth}
+             {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|}
+}
+{\end{tabular*}\par}
+\newcommand{\entrylabel}[1]{
+   {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\\}}}
+\newenvironment{Desc}
+{\begin{list}{}
+  {
+    \settowidth{\labelwidth}{40pt}
+    \setlength{\leftmargin}{\labelwidth}
+    \setlength{\parsep}{0pt}
+    \setlength{\itemsep}{-4pt}
+    \renewcommand{\makelabel}{\entrylabel}
+  }
+}
+{\end{list}}
+\newenvironment{Indent}
+  {\begin{list}{}{\setlength{\leftmargin}{0.5cm}}
+      \item[]\ignorespaces}
+  {\unskip\end{list}}
+\setlength{\parindent}{0cm}
+\setlength{\parskip}{0.2cm}
+\addtocounter{secnumdepth}{1}
+\sloppy
+\usepackage[T1]{fontenc}

diff --git a/docs/api/make_pdf_manuals.sh b/docs/api/make_pdf_manuals.sh
new file mode 100755 (executable)
index 0000000..b42dff4
--- /dev/null
+++ b/docs/api/make_pdf_manuals.sh
@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# Limplia las referencias del manual de Administración.
+#
+# $Id#
+
+cat admin/main.tex | sed 's/{\\rm.\{5,50\}})}//g' > admin/main2.tex
+mv -f admin/main2.tex admin/main.tex
+
+for manual in admin devel; do
+       cp -f refman_$manual.tex $manual/refman.tex
+       cp -f doxygen_$manual.sty $manual/doxygen.sty
+       cd $manual; make; cd ..
+done
+

diff --git a/docs/api/refman_admin.tex b/docs/api/refman_admin.tex
index 6119641955126beb086b47d21f6109b536d945b7..6acbde36e3376c28a7e3b172e74a4c26dc8a6ffa 100644 (file)
--- a/docs/api/refman_admin.tex
+++ b/docs/api/refman_admin.tex
@@ -10,18 +10,23 @@
 \usepackage{alltt}
 \usepackage[spanish]{babel}
 \usepackage{doxygen}
+\usepackage{palatino}
 \makeindex
-\setcounter{tocdepth}{1}
+\setcounter{tocdepth}{2}
 \renewcommand{\footrulewidth}{0.4pt}
 \begin{document}
 \begin{titlepage}
 \vspace*{7cm}
 \begin{center}
-{\Large Plaqui Manual de Administrador\\[1ex]\large 1.0 }\\
+{\Large PlaQui\\[1ex]\large 1.0 }\\
 \vspace*{1cm}
-{\large Generado por Doxygen 1.3.4}\\
+{\large Manual de Administraci\'{o}n}\\
 \vspace*{0.5cm}
-{\small Mon Dec 1 23:38:07 2003}\\
+{\small Nicol\'{a}s Dimov}\\
+\vspace*{0.1cm}
+{\small Leandro Lucarella}\\
+\vspace*{0.1cm}
+{\small Ricardo Markiewickz}\\
 \end{center}
 \end{titlepage}
 \clearemptydoublepage
@@ -29,7 +34,7 @@
 \tableofcontents
 \clearemptydoublepage
 \pagenumbering{arabic}
-\chapter{Plaqui }
+\chapter{Manual de Administraci\'{o}n}
 \label{index}\input{main}
 \printindex
 \end{document}

diff --git a/docs/api/refman_devel.tex b/docs/api/refman_devel.tex
index c0171838cd2e47f63e3a0dd4ed5591f90364c3aa..db43068955924906bd1b824120957fba65e041fd 100644 (file)
--- a/docs/api/refman_devel.tex
+++ b/docs/api/refman_devel.tex
@@ -10,6 +10,7 @@
 \usepackage{alltt}
 \usepackage[spanish]{babel}
 \usepackage{doxygen}
+\usepackage{palatino}
 \makeindex
 \setcounter{tocdepth}{1}
 \renewcommand{\footrulewidth}{0.4pt}
@@ -17,11 +18,15 @@
 \begin{titlepage}
 \vspace*{7cm}
 \begin{center}
-{\Large Plaqui Manual de referencia\\[1ex]\large 1.0 }\\
+{\Large Plaqui\\[1ex]\large 1.0 }\\
 \vspace*{1cm}
-{\large Generado por Doxygen 1.3.4}\\
+{\large Manual de Desarrollo}\\
 \vspace*{0.5cm}
-{\small Mon Dec 1 23:38:07 2003}\\
+{\small Nicol\'{a}s Dimov}\\
+\vspace*{0.1cm}
+{\small Leandro Lucarella}\\
+\vspace*{0.1cm}
+{\small Ricardo Markiewickz}\\
 \end{center}
 \end{titlepage}
 \clearemptydoublepage
@@ -29,15 +34,17 @@
 \tableofcontents
 \clearemptydoublepage
 \pagenumbering{arabic}
-\chapter{PlaQui versi\'{o}n 1.0}
+\chapter{Introducci\'{o}n}
 \label{index}\input{main}
 \chapter{PlaQui Model}
 \input{page_model}
 \chapter{PlaQui Server}
 \input{page_server}
+\chapter{PlaQui Client}
+\input{page_client}
 \chapter{PlaQui Constructor}
 \input{page_constructor}
-\chapter{Plaqui Documentaci\'{o}n de namespace}
+\chapter{Plaqui Documentaci\'{o}n de espacio de nombres}
 \input{namespacePlaQui}
 \include{namespacePlaQui_1_1Model}
 \include{namespacePlaQui_1_1Server}