Readme.txt file for the latex package "pst-uml" ----------------------------------------------- When-Who-Where? -------------- who: Maurice Diamantini Maintained by: Herbert Voss where: http://www.ensta.fr/~diam/latex/contrib/ (and CTAN) when: Package "pst-uml": 27/04/98 FRENCH doc "pst-uml": 27/04/98 this readme: 18/12/98 :-) see "Modifications" for more recent changes pst-uml is in Alpha version, and not yet cleanly packaged. No more feature have been added since 1998. pst-uml is just maintained thanks to the great help from Herbert Voss (following pstricks evolution, putting it onto CTAN, ..). See at the bottom of this README for the last changes. ********** (But any remarks are welcome :-) **************** What is pst-uml --------------- pst-uml.sty is a latex package written for my need to draw some UML diagramms using pstricks package. "pst-uml" rely on pstricks (pst-keys.sty) and some other standard packages. In particular the following files : - pst-xkeys.sty : use by pst-uml.sty but include in recent standard latex distribution. - fancyvrb.sty : NOT USE by pst-uml.sty, but requested for compiling the documentations. - fvrb-ex.sty : idem above How to use pst-uml? ------------------- Copy the file pst-uml.sty in your working directory (latex project) or in the PATH of TEX input file. Normaly, this is the only thing to do... Documentation ------------- All documentation is IN FRENCH (soory about that). It is composed by one top file: pst-uml-doc.tex which call four independant files, one for each final exemple : - diagCase.tex - diagClass.tex - diagState.tex - diagSeq.tex Compiling the documentation files require the packages fancyvrb.sty and fvrb-ex.sty in addition to the pst-uml.sty package. A pdf version of the documentation is provided with the "pst-uml" distribution. Makefile -------- With unix (or macosX), you can use Makefile for compiling documentations to pdf (require ps2pdf utility): make => compile the documentation file to pdf format and the encapsulated pdf exemple (and remove some tex generated files) make distcleen => remove all generated files (with pdf ones) make tgz (ou tbz or zip for other format) => make a snapshot with date and time of the directory, and put it in the parent directory The Makefile can be used to see the various needed unix commands (in particular for building encapsulated pdf figure). Using pstricks with pdflatex. ----------------------------- pdflatex doesn't accept ps code neither eps file as external figure. And the common tools for converting ps file to pdf ones doen't respect the bounding box. One solution is to use a pstrick feature for make an eps file, then use the epstopdf tool for conversion. A self-documented exemple for creating such encasulated pdf file is provided in "pst-uml-encapsuled-pdf-fig.tex". This feature make use of: - "-E" flag for dvips tool, - epstopdf unix filter, - \usepackage{pst-eps} from pstricks, - \TeXtoEPS and \endTeXtoEPS commands from pstricks Modifications ------------- 31/08/06 : some more cleanup, (pst-uml unchanged) ... 28/08/06 : - using pst-xkey for the key handling, - add exemple for creating encapsulated pdf figure - doc file renamed, and cleanup Makefile and README 14/05/03 : apply licence lppl before putting pst-uml on CTAM (by Herbert Voss) 18/12/98 : modif Makefile and remove out-dated packages from pst-uml distribution. 27/04/98 : last update of pst-uml and its documentation ./