diff --git a/doc/dev/php/latex/Makefile b/doc/dev/php/latex/Makefile new file mode 100644 index 00000000000..e464a002a1d --- /dev/null +++ b/doc/dev/php/latex/Makefile @@ -0,0 +1,18 @@ +all: refman.pdf + +refman.pdf: refman.tex + pdflatex refman.tex + makeindex refman.idx + pdflatex refman.tex + + latex_count=5 ; \ + while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $$latex_count -gt 0 ] ;\ + do \ + echo "Rerunning latex...." ;\ + pdflatex refman.tex ;\ + latex_count=`expr $$latex_count - 1` ;\ + done + + +clean: + rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out refman.pdf diff --git a/doc/dev/php/latex/doxygen.sty b/doc/dev/php/latex/doxygen.sty new file mode 100644 index 00000000000..86c504250ab --- /dev/null +++ b/doc/dev/php/latex/doxygen.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 G\'{e}n\'{e}r\'{e} le Thu Jul 15 14:51:58 2004 pour dolibarr par Doxygen }]{} +\lfoot[]{\fancyplain{}{\bfseries\scriptsize G\'{e}n\'{e}r\'{e} le Thu Jul 15 14:51:58 2004 pour dolibarr par Doxygen }} +\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/doc/dev/php/latex/files.tex b/doc/dev/php/latex/files.tex new file mode 100644 index 00000000000..2cce1195cfc --- /dev/null +++ b/doc/dev/php/latex/files.tex @@ -0,0 +1,10 @@ +\section{dolibarr Liste des fichiers} +Liste de tous les fichiers document\'{e}s avec une br\`{e}ve description:\begin{CompactList} +\item\contentsline{section}{htdocs/lib/{\bf CMail\-File.class.php} }{\pageref{CMailFile_8class_8php}}{} +\item\contentsline{section}{htdocs/lib/{\bf functions.inc.php} }{\pageref{functions_8inc_8php}}{} +\item\contentsline{section}{htdocs/lib/\hyperlink{ldap_8lib_8php}{ldap.lib.php} (Librairie contenant les fonctions pour acc\`{e}der au serveur ldap )}{\pageref{ldap_8lib_8php}}{} +\item\contentsline{section}{htdocs/lib/\hyperlink{mysql_8lib_8php}{mysql.lib.php} (Classes permettant de g\'{e}r\'{e}r la database de dolibarr )}{\pageref{mysql_8lib_8php}}{} +\item\contentsline{section}{htdocs/lib/\hyperlink{price_8lib_8php}{price.lib.php} (Librairie contenant les fonctions pour calculer un prix )}{\pageref{price_8lib_8php}}{} +\item\contentsline{section}{htdocs/lib/\hyperlink{thermometer_8php}{thermometer.php} (Classe permettant d'afficher un thermometre )}{\pageref{thermometer_8php}}{} +\item\contentsline{section}{htdocs/lib/\hyperlink{webcal_8class_8php}{webcal.class.php} (Classe permettant d'acceder a la database webcalendar )}{\pageref{webcal_8class_8php}}{} +\end{CompactList} diff --git a/doc/dev/php/latex/ldap_8lib_8php.tex b/doc/dev/php/latex/ldap_8lib_8php.tex new file mode 100644 index 00000000000..b06f0fcaa76 --- /dev/null +++ b/doc/dev/php/latex/ldap_8lib_8php.tex @@ -0,0 +1,142 @@ +\hypertarget{ldap_8lib_8php}{ +\section{R\'{e}f\'{e}rence du fichier htdocs/lib/ldap.lib.php} +\label{ldap_8lib_8php}\index{htdocs/lib/ldap.lib.php@{htdocs/lib/ldap.lib.php}} +} +Librairie contenant les fonctions pour acc\`{e}der au serveur ldap. + + +\subsection*{Fonctions} +\begin{CompactItemize} +\item +\hyperlink{ldap_8lib_8php_a0}{dolibarr\_\-ldap\_\-connect} () +\begin{CompactList}\small\item\em ouverture d'une connection vers le serveur ldap. \item\end{CompactList}\item +\hyperlink{ldap_8lib_8php_a1}{dolibarr\_\-ldap\_\-bind} (\$ds) +\begin{CompactList}\small\item\em bind au serveur ldap. \item\end{CompactList}\item +\hyperlink{ldap_8lib_8php_a2}{dolibarr\_\-ldap\_\-unbind} (\$ds) +\begin{CompactList}\small\item\em unbind du serveur ldap. \item\end{CompactList}\item +\hyperlink{ldap_8lib_8php_a3}{dolibarr\_\-ldap\_\-getversion} (\$ds) +\begin{CompactList}\small\item\em verification de la version du serveur ldap. \item\end{CompactList}\item +\hyperlink{ldap_8lib_8php_a4}{dolibarr\_\-ldap\_\-setversion} (\$ds, \$version) +\begin{CompactList}\small\item\em changement de la version du serveur ldap. \item\end{CompactList}\item +\hyperlink{ldap_8lib_8php_a5}{dolibarr\_\-ldap\_\-unacc} (\$str) +\begin{CompactList}\small\item\em permet d'enlever les accents d'une chaine. \item\end{CompactList}\end{CompactItemize} + + +\subsection{Description d\'{e}taill\'{e}e} +Librairie contenant les fonctions pour acc\`{e}der au serveur ldap. + +\begin{Desc} +\item[Auteur:]Rodolphe Quiedeville. + +Benoit Mortier. \end{Desc} +\begin{Desc} +\item[Version:]1.2.\end{Desc} +Ensemble des fonctions permettant d'acc\`{e}der \`{a} un serveur ldap. + +D\'{e}finition dans le fichier \hyperlink{ldap_8lib_8php-source}{ldap.lib.php}. + +\subsection{Documentation des fonctions} +\hypertarget{ldap_8lib_8php_a1}{ +\index{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_bind@{dolibarr\_\-ldap\_\-bind}} +\index{dolibarr_ldap_bind@{dolibarr\_\-ldap\_\-bind}!ldap.lib.php@{ldap.lib.php}} +\subsubsection[dolibarr\_\-ldap\_\-bind]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-ldap\_\-bind (\$ {\em ds})}} +\label{ldap_8lib_8php_a1} + + +bind au serveur ldap. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em ds}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]bool \end{Desc} + + +D\'{e}finition \`{a} la ligne 54 du fichier ldap.lib.php.\hypertarget{ldap_8lib_8php_a0}{ +\index{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_connect@{dolibarr\_\-ldap\_\-connect}} +\index{dolibarr_ldap_connect@{dolibarr\_\-ldap\_\-connect}!ldap.lib.php@{ldap.lib.php}} +\subsubsection[dolibarr\_\-ldap\_\-connect]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-ldap\_\-connect ()}} +\label{ldap_8lib_8php_a0} + + +ouverture d'une connection vers le serveur ldap. + +\begin{Desc} +\item[Renvoie:]resource \end{Desc} + + +D\'{e}finition \`{a} la ligne 40 du fichier ldap.lib.php.\hypertarget{ldap_8lib_8php_a3}{ +\index{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_getversion@{dolibarr\_\-ldap\_\-getversion}} +\index{dolibarr_ldap_getversion@{dolibarr\_\-ldap\_\-getversion}!ldap.lib.php@{ldap.lib.php}} +\subsubsection[dolibarr\_\-ldap\_\-getversion]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-ldap\_\-getversion (\$ {\em ds})}} +\label{ldap_8lib_8php_a3} + + +verification de la version du serveur ldap. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em ds}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]version \end{Desc} + + +D\'{e}finition \`{a} la ligne 84 du fichier ldap.lib.php.\hypertarget{ldap_8lib_8php_a4}{ +\index{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_setversion@{dolibarr\_\-ldap\_\-setversion}} +\index{dolibarr_ldap_setversion@{dolibarr\_\-ldap\_\-setversion}!ldap.lib.php@{ldap.lib.php}} +\subsubsection[dolibarr\_\-ldap\_\-setversion]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-ldap\_\-setversion (\$ {\em ds}, \$ {\em version})}} +\label{ldap_8lib_8php_a4} + + +changement de la version du serveur ldap. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em ds}]\item[{\em version}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]version \end{Desc} + + +D\'{e}finition \`{a} la ligne 101 du fichier ldap.lib.php.\hypertarget{ldap_8lib_8php_a5}{ +\index{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_unacc@{dolibarr\_\-ldap\_\-unacc}} +\index{dolibarr_ldap_unacc@{dolibarr\_\-ldap\_\-unacc}!ldap.lib.php@{ldap.lib.php}} +\subsubsection[dolibarr\_\-ldap\_\-unacc]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-ldap\_\-unacc (\$ {\em str})}} +\label{ldap_8lib_8php_a5} + + +permet d'enlever les accents d'une chaine. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em str}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]string \end{Desc} + + +D\'{e}finition \`{a} la ligne 114 du fichier ldap.lib.php.\hypertarget{ldap_8lib_8php_a2}{ +\index{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_unbind@{dolibarr\_\-ldap\_\-unbind}} +\index{dolibarr_ldap_unbind@{dolibarr\_\-ldap\_\-unbind}!ldap.lib.php@{ldap.lib.php}} +\subsubsection[dolibarr\_\-ldap\_\-unbind]{\setlength{\rightskip}{0pt plus 5cm}dolibarr\_\-ldap\_\-unbind (\$ {\em ds})}} +\label{ldap_8lib_8php_a2} + + +unbind du serveur ldap. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em ds}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]bool \end{Desc} + + +D\'{e}finition \`{a} la ligne 70 du fichier ldap.lib.php. \ No newline at end of file diff --git a/doc/dev/php/latex/mysql_8lib_8php.aux b/doc/dev/php/latex/mysql_8lib_8php.aux new file mode 100644 index 00000000000..0ae5ab5eb7f --- /dev/null +++ b/doc/dev/php/latex/mysql_8lib_8php.aux @@ -0,0 +1,27 @@ +\relax +\@writefile{toc}{\contentsline {section}{\numberline {2.2}R\'{e}f\'{e}rence du fichier htdocs/lib/mysql.lib.php}{6}{section.2.2}} +\newlabel{mysql_8lib_8php}{{2.2}{6}{R\'{e}f\'{e}rence du fichier htdocs/lib/mysql.lib.php\relax }{section.2.2}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2.1}Description d\'{e}taill\'{e}e}{6}{subsection.2.2.1}} +\@setckpt{mysql_8lib_8php}{ +\setcounter{page}{7} +\setcounter{equation}{0} +\setcounter{enumi}{0} +\setcounter{enumii}{0} +\setcounter{enumiii}{0} +\setcounter{enumiv}{0} +\setcounter{footnote}{0} +\setcounter{mpfootnote}{0} +\setcounter{part}{0} +\setcounter{chapter}{2} +\setcounter{section}{2} +\setcounter{subsection}{1} +\setcounter{subsubsection}{0} +\setcounter{paragraph}{0} +\setcounter{subparagraph}{0} +\setcounter{figure}{0} +\setcounter{table}{0} +\setcounter{float@type}{4} +\setcounter{Item}{0} +\setcounter{Hfootnote}{0} +\setcounter{section@level}{2} +} diff --git a/doc/dev/php/latex/mysql_8lib_8php.tex b/doc/dev/php/latex/mysql_8lib_8php.tex new file mode 100644 index 00000000000..9b80115a721 --- /dev/null +++ b/doc/dev/php/latex/mysql_8lib_8php.tex @@ -0,0 +1,23 @@ +\hypertarget{mysql_8lib_8php}{ +\section{R\'{e}f\'{e}rence du fichier htdocs/lib/mysql.lib.php} +\label{mysql_8lib_8php}\index{htdocs/lib/mysql.lib.php@{htdocs/lib/mysql.lib.php}} +} +Classes permettant de g\'{e}r\'{e}r la database de dolibarr. + + + + +\subsection{Description d\'{e}taill\'{e}e} +Classes permettant de g\'{e}r\'{e}r la database de dolibarr. + +\begin{Desc} +\item[Auteur:]Fabien Seisen + +Rodolphe Quiedeville. + +Laurent Destailleur. \end{Desc} +\begin{Desc} +\item[Version:]1.2.\end{Desc} +Ensemble des fonctions permettant de g\'{e}rer la database de dolibarr. + +D\'{e}finition dans le fichier \hyperlink{mysql_8lib_8php-source}{mysql.lib.php}. \ No newline at end of file diff --git a/doc/dev/php/latex/price_8lib_8php.aux b/doc/dev/php/latex/price_8lib_8php.aux new file mode 100644 index 00000000000..65fab0e6967 --- /dev/null +++ b/doc/dev/php/latex/price_8lib_8php.aux @@ -0,0 +1,30 @@ +\relax +\@writefile{toc}{\contentsline {section}{\numberline {2.3}R\'{e}f\'{e}rence du fichier htdocs/lib/price.lib.php}{7}{section.2.3}} +\newlabel{price_8lib_8php}{{2.3}{7}{R\'{e}f\'{e}rence du fichier htdocs/lib/price.lib.php\relax }{section.2.3}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.1}Description d\'{e}taill\'{e}e}{7}{subsection.2.3.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.3.2}Documentation des fonctions}{7}{subsection.2.3.2}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.3.2.1}calcul\_\discretionary {-}{}{}price}{7}{subsubsection.2.3.2.1}} +\newlabel{price_8lib_8php_a0}{{2.3.2.1}{7}{calcul\_\-price\relax }{subsubsection.2.3.2.1}{}} +\@setckpt{price_8lib_8php}{ +\setcounter{page}{8} +\setcounter{equation}{0} +\setcounter{enumi}{0} +\setcounter{enumii}{0} +\setcounter{enumiii}{0} +\setcounter{enumiv}{0} +\setcounter{footnote}{0} +\setcounter{mpfootnote}{0} +\setcounter{part}{0} +\setcounter{chapter}{2} +\setcounter{section}{3} +\setcounter{subsection}{2} +\setcounter{subsubsection}{1} +\setcounter{paragraph}{0} +\setcounter{subparagraph}{0} +\setcounter{figure}{0} +\setcounter{table}{0} +\setcounter{float@type}{4} +\setcounter{Item}{0} +\setcounter{Hfootnote}{0} +\setcounter{section@level}{3} +} diff --git a/doc/dev/php/latex/price_8lib_8php.tex b/doc/dev/php/latex/price_8lib_8php.tex new file mode 100644 index 00000000000..1fbe322dd95 --- /dev/null +++ b/doc/dev/php/latex/price_8lib_8php.tex @@ -0,0 +1,45 @@ +\hypertarget{price_8lib_8php}{ +\section{R\'{e}f\'{e}rence du fichier htdocs/lib/price.lib.php} +\label{price_8lib_8php}\index{htdocs/lib/price.lib.php@{htdocs/lib/price.lib.php}} +} +librairie contenant les fonctions pour calculer un prix. + + +\subsection*{Fonctions} +\begin{CompactItemize} +\item +\hyperlink{price_8lib_8php_a0}{calcul\_\-price} (\$products, \$remise\_\-percent) +\begin{CompactList}\small\item\em permet de calculer un prix. \item\end{CompactList}\end{CompactItemize} + + +\subsection{Description d\'{e}taill\'{e}e} +librairie contenant les fonctions pour calculer un prix. + +\begin{Desc} +\item[Auteur:]Rodolphe Quiedeville. \end{Desc} +\begin{Desc} +\item[Version:]1.2.\end{Desc} +Ensemble des fonctions permettant de calculer un prix. + +D\'{e}finition dans le fichier \hyperlink{price_8lib_8php-source}{price.lib.php}. + +\subsection{Documentation des fonctions} +\hypertarget{price_8lib_8php_a0}{ +\index{price.lib.php@{price.lib.php}!calcul_price@{calcul\_\-price}} +\index{calcul_price@{calcul\_\-price}!price.lib.php@{price.lib.php}} +\subsubsection[calcul\_\-price]{\setlength{\rightskip}{0pt plus 5cm}calcul\_\-price (\$ {\em products}, \$ {\em remise\_\-percent})}} +\label{price_8lib_8php_a0} + + +permet de calculer un prix. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em products}]\item[{\em remise\_\-percent}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]result \end{Desc} + + +D\'{e}finition \`{a} la ligne 38 du fichier price.lib.php. \ No newline at end of file diff --git a/doc/dev/php/latex/refman.aux b/doc/dev/php/latex/refman.aux new file mode 100644 index 00000000000..0b09b9e583a --- /dev/null +++ b/doc/dev/php/latex/refman.aux @@ -0,0 +1,48 @@ +\relax +\ifx\hyper@anchor\@undefined +\global \let \oldcontentsline\contentsline +\gdef \contentsline#1#2#3#4{\oldcontentsline{#1}{#2}{#3}} +\global \let \oldnewlabel\newlabel +\gdef \newlabel#1#2{\newlabelxx{#1}#2} +\gdef \newlabelxx#1#2#3#4#5#6{\oldnewlabel{#1}{{#2}{#3}}} +\AtEndDocument{\let \contentsline\oldcontentsline +\let \newlabel\oldnewlabel} +\else +\global \let \hyper@last\relax +\fi + +\catcode`:\active +\catcode`;\active +\catcode`!\active +\catcode`?\active +\select@language{french} +\@writefile{toc}{\select@language{french}} +\@writefile{lof}{\select@language{french}} +\@writefile{lot}{\select@language{french}} +\@writefile{toc}{\contentsline {chapter}{\numberline {1}dolibarr Index des fichiers}{1}{chapter.1}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\@writefile{toc}{\contentsline {section}{\numberline {1.1}dolibarr Liste des fichiers}{1}{section.1.1}} +\@writefile{toc}{\contentsline {chapter}{\numberline {2}dolibarr Documentation des fichiers}{3}{chapter.2}} +\@writefile{lof}{\addvspace {10\p@ }} +\@writefile{lot}{\addvspace {10\p@ }} +\@writefile{toc}{\contentsline {section}{\numberline {2.1}R\'{e}f\'{e}rence du fichier htdocs/lib/ldap.lib.php}{3}{section.2.1}} +\newlabel{ldap_8lib_8php}{{2.1}{3}{R\'{e}f\'{e}rence du fichier htdocs/lib/ldap.lib.php\relax }{section.2.1}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.1}Description d\'{e}taill\'{e}e}{3}{subsection.2.1.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1.2}Documentation des fonctions}{4}{subsection.2.1.2}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.1.2.1}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}bind}{4}{subsubsection.2.1.2.1}} +\newlabel{ldap_8lib_8php_a1}{{2.1.2.1}{4}{dolibarr\_\-ldap\_\-bind\relax }{subsubsection.2.1.2.1}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.1.2.2}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}connect}{4}{subsubsection.2.1.2.2}} +\newlabel{ldap_8lib_8php_a0}{{2.1.2.2}{4}{dolibarr\_\-ldap\_\-connect\relax }{subsubsection.2.1.2.2}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.1.2.3}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}getversion}{4}{subsubsection.2.1.2.3}} +\newlabel{ldap_8lib_8php_a3}{{2.1.2.3}{4}{dolibarr\_\-ldap\_\-getversion\relax }{subsubsection.2.1.2.3}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.1.2.4}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}setversion}{4}{subsubsection.2.1.2.4}} +\newlabel{ldap_8lib_8php_a4}{{2.1.2.4}{4}{dolibarr\_\-ldap\_\-setversion\relax }{subsubsection.2.1.2.4}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.1.2.5}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unacc}{5}{subsubsection.2.1.2.5}} +\newlabel{ldap_8lib_8php_a5}{{2.1.2.5}{5}{dolibarr\_\-ldap\_\-unacc\relax }{subsubsection.2.1.2.5}{}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.1.2.6}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unbind}{5}{subsubsection.2.1.2.6}} +\newlabel{ldap_8lib_8php_a2}{{2.1.2.6}{5}{dolibarr\_\-ldap\_\-unbind\relax }{subsubsection.2.1.2.6}{}} +\@input{mysql_8lib_8php.aux} +\@input{price_8lib_8php.aux} +\@input{thermometer_8php.aux} +\@input{webcal_8class_8php.aux} diff --git a/doc/dev/php/latex/refman.idx b/doc/dev/php/latex/refman.idx new file mode 100644 index 00000000000..5fd86bc3ce1 --- /dev/null +++ b/doc/dev/php/latex/refman.idx @@ -0,0 +1,21 @@ +\indexentry{htdocs/lib/ldap.lib.php@{htdocs/lib/ldap.lib.php}|hyperpage}{3} +\indexentry{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_bind@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}bind}|hyperpage}{4} +\indexentry{dolibarr_ldap_bind@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}bind}!ldap.lib.php@{ldap.lib.php}|hyperpage}{4} +\indexentry{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_connect@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}connect}|hyperpage}{4} +\indexentry{dolibarr_ldap_connect@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}connect}!ldap.lib.php@{ldap.lib.php}|hyperpage}{4} +\indexentry{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_getversion@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}getversion}|hyperpage}{4} +\indexentry{dolibarr_ldap_getversion@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}getversion}!ldap.lib.php@{ldap.lib.php}|hyperpage}{4} +\indexentry{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_setversion@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}setversion}|hyperpage}{4} +\indexentry{dolibarr_ldap_setversion@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}setversion}!ldap.lib.php@{ldap.lib.php}|hyperpage}{4} +\indexentry{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_unacc@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unacc}|hyperpage}{5} +\indexentry{dolibarr_ldap_unacc@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unacc}!ldap.lib.php@{ldap.lib.php}|hyperpage}{5} +\indexentry{ldap.lib.php@{ldap.lib.php}!dolibarr_ldap_unbind@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unbind}|hyperpage}{5} +\indexentry{dolibarr_ldap_unbind@{dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unbind}!ldap.lib.php@{ldap.lib.php}|hyperpage}{5} +\indexentry{htdocs/lib/mysql.lib.php@{htdocs/lib/mysql.lib.php}|hyperpage}{6} +\indexentry{htdocs/lib/price.lib.php@{htdocs/lib/price.lib.php}|hyperpage}{7} +\indexentry{price.lib.php@{price.lib.php}!calcul_price@{calcul\_\discretionary {-}{}{}price}|hyperpage}{7} +\indexentry{calcul_price@{calcul\_\discretionary {-}{}{}price}!price.lib.php@{price.lib.php}|hyperpage}{7} +\indexentry{htdocs/lib/thermometer.php@{htdocs/lib/thermometer.php}|hyperpage}{8} +\indexentry{thermometer.php@{thermometer.php}!moneyMeter@{moneyMeter}|hyperpage}{8} +\indexentry{moneyMeter@{moneyMeter}!thermometer.php@{thermometer.php}|hyperpage}{8} +\indexentry{htdocs/lib/webcal.class.php@{htdocs/lib/webcal.class.php}|hyperpage}{9} diff --git a/doc/dev/php/latex/refman.ilg b/doc/dev/php/latex/refman.ilg new file mode 100644 index 00000000000..ed535cbf1e3 --- /dev/null +++ b/doc/dev/php/latex/refman.ilg @@ -0,0 +1,6 @@ +This is makeindex, version 2.13 [07-Mar-1997] (using kpathsea). +Scanning input file refman.idx....done (21 entries accepted, 0 rejected). +Sorting entries....done (105 comparisons). +Generating output file refman.ind....done (60 lines written, 0 warnings). +Output written in refman.ind. +Transcript written in refman.ilg. diff --git a/doc/dev/php/latex/refman.ind b/doc/dev/php/latex/refman.ind new file mode 100644 index 00000000000..8ed07a7aa9b --- /dev/null +++ b/doc/dev/php/latex/refman.ind @@ -0,0 +1,60 @@ +\begin{theindex} + + \item {calcul\_\discretionary {-}{}{}price} + \subitem {price.lib.php}, \hyperpage{7} + + \indexspace + + \item {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}bind} + \subitem {ldap.lib.php}, \hyperpage{4} + \item {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}connect} + \subitem {ldap.lib.php}, \hyperpage{4} + \item {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}getversion} + \subitem {ldap.lib.php}, \hyperpage{4} + \item {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}setversion} + \subitem {ldap.lib.php}, \hyperpage{4} + \item {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unacc} + \subitem {ldap.lib.php}, \hyperpage{5} + \item {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unbind} + \subitem {ldap.lib.php}, \hyperpage{5} + + \indexspace + + \item {htdocs/lib/ldap.lib.php}, \hyperpage{3} + \item {htdocs/lib/mysql.lib.php}, \hyperpage{6} + \item {htdocs/lib/price.lib.php}, \hyperpage{7} + \item {htdocs/lib/thermometer.php}, \hyperpage{8} + \item {htdocs/lib/webcal.class.php}, \hyperpage{9} + + \indexspace + + \item {ldap.lib.php} + \subitem {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}bind}, + \hyperpage{4} + \subitem {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}connect}, + \hyperpage{4} + \subitem {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}getversion}, + \hyperpage{4} + \subitem {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}setversion}, + \hyperpage{4} + \subitem {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unacc}, + \hyperpage{5} + \subitem {dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unbind}, + \hyperpage{5} + + \indexspace + + \item {moneyMeter} + \subitem {thermometer.php}, \hyperpage{8} + + \indexspace + + \item {price.lib.php} + \subitem {calcul\_\discretionary {-}{}{}price}, \hyperpage{7} + + \indexspace + + \item {thermometer.php} + \subitem {moneyMeter}, \hyperpage{8} + +\end{theindex} diff --git a/doc/dev/php/latex/refman.out b/doc/dev/php/latex/refman.out new file mode 100644 index 00000000000..e2291484f8a --- /dev/null +++ b/doc/dev/php/latex/refman.out @@ -0,0 +1,8 @@ +\BOOKMARK [0][-]{chapter.1}{dolibarr Index des fichiers}{} +\BOOKMARK [1][-]{section.1.1}{dolibarr Liste des fichiers}{chapter.1} +\BOOKMARK [0][-]{chapter.2}{dolibarr Documentation des fichiers}{} +\BOOKMARK [1][-]{section.2.1}{R\351f\351rence du fichier htdocs/lib/ldap.lib.php}{chapter.2} +\BOOKMARK [1][-]{section.2.2}{R\351f\351rence du fichier htdocs/lib/mysql.lib.php}{chapter.2} +\BOOKMARK [1][-]{section.2.3}{R\351f\351rence du fichier htdocs/lib/price.lib.php}{chapter.2} +\BOOKMARK [1][-]{section.2.4}{R\351f\351rence du fichier htdocs/lib/thermometer.php}{chapter.2} +\BOOKMARK [1][-]{section.2.5}{R\351f\351rence du fichier htdocs/lib/webcal.class.php}{chapter.2} diff --git a/doc/dev/php/latex/refman.pdf b/doc/dev/php/latex/refman.pdf new file mode 100644 index 00000000000..dd9b4d460ca Binary files /dev/null and b/doc/dev/php/latex/refman.pdf differ diff --git a/doc/dev/php/latex/refman.tex b/doc/dev/php/latex/refman.tex new file mode 100644 index 00000000000..8e9d895a164 --- /dev/null +++ b/doc/dev/php/latex/refman.tex @@ -0,0 +1,55 @@ +\documentclass[a4paper]{book} +\usepackage{makeidx} +\usepackage{fancyhdr} +\usepackage{graphicx} +\usepackage{multicol} +\usepackage{float} +\usepackage{textcomp} +\usepackage{alltt} +\usepackage{times} +\ifx\pdfoutput\undefined +\usepackage[ps2pdf, + pagebackref=true, + colorlinks=true, + linkcolor=blue + ]{hyperref} +\usepackage{pspicture} +\else +\usepackage[pdftex, + pagebackref=true, + colorlinks=true, + linkcolor=blue + ]{hyperref} +\fi +\usepackage[french]{babel} + +\usepackage{doxygen} +\makeindex +\setcounter{tocdepth}{1} +\renewcommand{\footrulewidth}{0.4pt} +\begin{document} +\begin{titlepage} +\vspace*{7cm} +\begin{center} +{\Large dolibarr Manuel de r\'{e}f\'{e}rence\\[1ex]\large 1.2.0 }\\ +\vspace*{1cm} +{\large G\'{e}n\'{e}r\'{e} par Doxygen 1.3.7}\\ +\vspace*{0.5cm} +{\small Thu Jul 15 14:51:57 2004}\\ +\end{center} +\end{titlepage} +\clearemptydoublepage +\pagenumbering{roman} +\tableofcontents +\clearemptydoublepage +\pagenumbering{arabic} +\chapter{dolibarr Index des fichiers} +\input{files} +\chapter{dolibarr Documentation des fichiers} +\input{ldap_8lib_8php} +\include{mysql_8lib_8php} +\include{price_8lib_8php} +\include{thermometer_8php} +\include{webcal_8class_8php} +\printindex +\end{document} diff --git a/doc/dev/php/latex/refman.toc b/doc/dev/php/latex/refman.toc new file mode 100644 index 00000000000..00a40d03538 --- /dev/null +++ b/doc/dev/php/latex/refman.toc @@ -0,0 +1,25 @@ +\select@language {french} +\contentsline {chapter}{\numberline {1}dolibarr Index des fichiers}{1}{chapter.1} +\contentsline {section}{\numberline {1.1}dolibarr Liste des fichiers}{1}{section.1.1} +\contentsline {chapter}{\numberline {2}dolibarr Documentation des fichiers}{3}{chapter.2} +\contentsline {section}{\numberline {2.1}R\'{e}f\'{e}rence du fichier htdocs/lib/ldap.lib.php}{3}{section.2.1} +\contentsline {subsection}{\numberline {2.1.1}Description d\'{e}taill\'{e}e}{3}{subsection.2.1.1} +\contentsline {subsection}{\numberline {2.1.2}Documentation des fonctions}{4}{subsection.2.1.2} +\contentsline {subsubsection}{\numberline {2.1.2.1}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}bind}{4}{subsubsection.2.1.2.1} +\contentsline {subsubsection}{\numberline {2.1.2.2}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}connect}{4}{subsubsection.2.1.2.2} +\contentsline {subsubsection}{\numberline {2.1.2.3}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}getversion}{4}{subsubsection.2.1.2.3} +\contentsline {subsubsection}{\numberline {2.1.2.4}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}setversion}{4}{subsubsection.2.1.2.4} +\contentsline {subsubsection}{\numberline {2.1.2.5}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unacc}{5}{subsubsection.2.1.2.5} +\contentsline {subsubsection}{\numberline {2.1.2.6}dolibarr\_\discretionary {-}{}{}ldap\_\discretionary {-}{}{}unbind}{5}{subsubsection.2.1.2.6} +\contentsline {section}{\numberline {2.2}R\'{e}f\'{e}rence du fichier htdocs/lib/mysql.lib.php}{6}{section.2.2} +\contentsline {subsection}{\numberline {2.2.1}Description d\'{e}taill\'{e}e}{6}{subsection.2.2.1} +\contentsline {section}{\numberline {2.3}R\'{e}f\'{e}rence du fichier htdocs/lib/price.lib.php}{7}{section.2.3} +\contentsline {subsection}{\numberline {2.3.1}Description d\'{e}taill\'{e}e}{7}{subsection.2.3.1} +\contentsline {subsection}{\numberline {2.3.2}Documentation des fonctions}{7}{subsection.2.3.2} +\contentsline {subsubsection}{\numberline {2.3.2.1}calcul\_\discretionary {-}{}{}price}{7}{subsubsection.2.3.2.1} +\contentsline {section}{\numberline {2.4}R\'{e}f\'{e}rence du fichier htdocs/lib/thermometer.php}{8}{section.2.4} +\contentsline {subsection}{\numberline {2.4.1}Description d\'{e}taill\'{e}e}{8}{subsection.2.4.1} +\contentsline {subsection}{\numberline {2.4.2}Documentation des fonctions}{8}{subsection.2.4.2} +\contentsline {subsubsection}{\numberline {2.4.2.1}moneyMeter}{8}{subsubsection.2.4.2.1} +\contentsline {section}{\numberline {2.5}R\'{e}f\'{e}rence du fichier htdocs/lib/webcal.class.php}{9}{section.2.5} +\contentsline {subsection}{\numberline {2.5.1}Description d\'{e}taill\'{e}e}{9}{subsection.2.5.1} diff --git a/doc/dev/php/latex/thermometer_8php.aux b/doc/dev/php/latex/thermometer_8php.aux new file mode 100644 index 00000000000..ee0b031b7f2 --- /dev/null +++ b/doc/dev/php/latex/thermometer_8php.aux @@ -0,0 +1,30 @@ +\relax +\@writefile{toc}{\contentsline {section}{\numberline {2.4}R\'{e}f\'{e}rence du fichier htdocs/lib/thermometer.php}{8}{section.2.4}} +\newlabel{thermometer_8php}{{2.4}{8}{R\'{e}f\'{e}rence du fichier htdocs/lib/thermometer.php\relax }{section.2.4}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.1}Description d\'{e}taill\'{e}e}{8}{subsection.2.4.1}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.4.2}Documentation des fonctions}{8}{subsection.2.4.2}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.4.2.1}moneyMeter}{8}{subsubsection.2.4.2.1}} +\newlabel{thermometer_8php_a0}{{2.4.2.1}{8}{moneyMeter\relax }{subsubsection.2.4.2.1}{}} +\@setckpt{thermometer_8php}{ +\setcounter{page}{9} +\setcounter{equation}{0} +\setcounter{enumi}{0} +\setcounter{enumii}{0} +\setcounter{enumiii}{0} +\setcounter{enumiv}{0} +\setcounter{footnote}{0} +\setcounter{mpfootnote}{0} +\setcounter{part}{0} +\setcounter{chapter}{2} +\setcounter{section}{4} +\setcounter{subsection}{2} +\setcounter{subsubsection}{1} +\setcounter{paragraph}{0} +\setcounter{subparagraph}{0} +\setcounter{figure}{0} +\setcounter{table}{0} +\setcounter{float@type}{4} +\setcounter{Item}{0} +\setcounter{Hfootnote}{0} +\setcounter{section@level}{3} +} diff --git a/doc/dev/php/latex/thermometer_8php.tex b/doc/dev/php/latex/thermometer_8php.tex new file mode 100644 index 00000000000..265519cf51a --- /dev/null +++ b/doc/dev/php/latex/thermometer_8php.tex @@ -0,0 +1,47 @@ +\hypertarget{thermometer_8php}{ +\section{R\'{e}f\'{e}rence du fichier htdocs/lib/thermometer.php} +\label{thermometer_8php}\index{htdocs/lib/thermometer.php@{htdocs/lib/thermometer.php}} +} +Classe permettant d'afficher un thermometre. + + +\subsection*{Fonctions} +\begin{CompactItemize} +\item +\hyperlink{thermometer_8php_a0}{money\-Meter} (\$actual\-Value=0, \$pending\-Value=0, \$intent\-Value=0) +\begin{CompactList}\small\item\em permet d'afficher un thermometre monetaire. \item\end{CompactList}\end{CompactItemize} + + +\subsection{Description d\'{e}taill\'{e}e} +Classe permettant d'afficher un thermometre. + +\begin{Desc} +\item[Auteur:]Rodolphe Quiedeville. + +Timothy Kanters. \end{Desc} +\begin{Desc} +\item[Version:]1.2.\end{Desc} +Ensemble des fonctions permettant d'afficher un thermometre monetaire. + +D\'{e}finition dans le fichier \hyperlink{thermometer_8php-source}{thermometer.php}. + +\subsection{Documentation des fonctions} +\hypertarget{thermometer_8php_a0}{ +\index{thermometer.php@{thermometer.php}!moneyMeter@{moneyMeter}} +\index{moneyMeter@{moneyMeter}!thermometer.php@{thermometer.php}} +\subsubsection[moneyMeter]{\setlength{\rightskip}{0pt plus 5cm}money\-Meter (\$ {\em actual\-Value} = {\tt 0}, \$ {\em pending\-Value} = {\tt 0}, \$ {\em intent\-Value} = {\tt 0})}} +\label{thermometer_8php_a0} + + +permet d'afficher un thermometre monetaire. + +\begin{Desc} +\item[Param\`{e}tres:] +\begin{description} +\item[{\em actual\-Value}]\item[{\em pending\-Value}]\item[{\em intent\-Value}]\end{description} +\end{Desc} +\begin{Desc} +\item[Renvoie:]thermometer html\-Legenda \end{Desc} + + +D\'{e}finition \`{a} la ligne 42 du fichier thermometer.php. \ No newline at end of file diff --git a/doc/dev/php/latex/webcal_8class_8php.aux b/doc/dev/php/latex/webcal_8class_8php.aux new file mode 100644 index 00000000000..1797122cd96 --- /dev/null +++ b/doc/dev/php/latex/webcal_8class_8php.aux @@ -0,0 +1,27 @@ +\relax +\@writefile{toc}{\contentsline {section}{\numberline {2.5}R\'{e}f\'{e}rence du fichier htdocs/lib/webcal.class.php}{9}{section.2.5}} +\newlabel{webcal_8class_8php}{{2.5}{9}{R\'{e}f\'{e}rence du fichier htdocs/lib/webcal.class.php\relax }{section.2.5}{}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.5.1}Description d\'{e}taill\'{e}e}{9}{subsection.2.5.1}} +\@setckpt{webcal_8class_8php}{ +\setcounter{page}{10} +\setcounter{equation}{0} +\setcounter{enumi}{0} +\setcounter{enumii}{0} +\setcounter{enumiii}{0} +\setcounter{enumiv}{0} +\setcounter{footnote}{0} +\setcounter{mpfootnote}{0} +\setcounter{part}{0} +\setcounter{chapter}{2} +\setcounter{section}{5} +\setcounter{subsection}{1} +\setcounter{subsubsection}{0} +\setcounter{paragraph}{0} +\setcounter{subparagraph}{0} +\setcounter{figure}{0} +\setcounter{table}{0} +\setcounter{float@type}{4} +\setcounter{Item}{0} +\setcounter{Hfootnote}{0} +\setcounter{section@level}{2} +} diff --git a/doc/dev/php/latex/webcal_8class_8php.tex b/doc/dev/php/latex/webcal_8class_8php.tex new file mode 100644 index 00000000000..d3f93760049 --- /dev/null +++ b/doc/dev/php/latex/webcal_8class_8php.tex @@ -0,0 +1,19 @@ +\hypertarget{webcal_8class_8php}{ +\section{R\'{e}f\'{e}rence du fichier htdocs/lib/webcal.class.php} +\label{webcal_8class_8php}\index{htdocs/lib/webcal.class.php@{htdocs/lib/webcal.class.php}} +} +Classe permettant d'acceder a la database webcalendar. + + + + +\subsection{Description d\'{e}taill\'{e}e} +Classe permettant d'acceder a la database webcalendar. + +\begin{Desc} +\item[Auteur:]Rodolphe Quiedeville. \end{Desc} +\begin{Desc} +\item[Version:]1.2.\end{Desc} +Ensemble des fonctions permettant d'acceder a la database webcalendar. + +D\'{e}finition dans le fichier \hyperlink{webcal_8class_8php-source}{webcal.class.php}. \ No newline at end of file