ALLPROSE
ALLPROSE is an Aldor Literate Programming Support Environment.
It is intended for those who like to write a library in Aldor, but don't want to bother much with all the Makefiles, how to build a testsuite, and how to produce nice documentation.
ALLPROSE is a framework for building Aldor libraries and their documentation. It consists of a set of Makefiles and scripts for the building process and it comes with a little sample project MyAlps that demonstrates how to use the ALLPROSE environment.
- ALLPROSE builds the library of the project via Makefiles. Usually there is no need to write any new Makefile or to change anything in the Makefiles that are provided by ALLPROSE.
- It is usually enough to write categories and domains that form the library. ALLPROSE figures out in which order they have to be compiled. See tools/dependencies.pl for more details.
- ALLPROSE is a developing project itself, but ALLPROSE is reasonably separate from the Aldor code. By not altering files of the ALLPROSE distribution, it is even possible to update ALLPROSE to a newer version in a developing Aldor library project.
- ALLPROSE uses noweb as a literate programming system.
Writing noweb files is basically the same as writing LaTeX
files that contain code chunks in environments that look like
<<Name of a Code Chunk>>= Arbitrary code comes here @
The documentation can be written using the full power of LaTeX. ALLPROSE builds on the hyperref package to produce hyperlinks inside the resulting documentation. - ALLPROSE can produce a .dvi, .ps, .pdf, and .html form of the documentation of your library.
- ALLPROSE encourages to write test suites. Writing a testsuite becomes trivial. ALLPROSE supports the AldorUnit system by collecting the signatures from the test files, building a wrapper test/TestSuite.as file, and compiling and executing this file.
- ALLPROSE supports the inverse search feature of newer DVIVIEWERs. Developing the project library is done by having open both, a DVIVIEWER and an editor. Clicking on the text in the DVIVIEWER will automatically open the corresponding file in the editor of your choice and place the cursor to the nearest paragraph that corresponds to the mouse pointer.
- ALLPROSE is prepared to support the error search facility of Emacs and XEmacs, i.e., if the Aldor compiler reports an error, Emacs jumps to the error position in the source file (with extension .as.nw).
- ALLPROSE allows colored documentation output.
ALLPROSE is distributed under the GNU General Public License (Version 2).
- allprose-0.2.6.tar.gz: complete sources of ALLPROSE (including the documentation)
- allprose-0.2.6.pdf.gz: documentation of ALLPROSE
- (online) documentation of ALLPROSE
- (online) documentation of the MyAlps sample project that comes with ALLPROSE
I have packaged ALLPROSE and all of the necessary files below for easier installation.
- Get packaged-allprose.tar.gz.
- Store it into a directory /my/own/dir.
- Extract by
gunzip -c packaged-allprose.tar.gz | tar xvpf - - cd packaged-allprose
- cat README
- Follow the steps from the README, it is short enough.
The following files are important to set up a full functional ALLPROSE.
- rhxterm.sty: necessary for ALLPROSE
- rhxterm.sty.nw: documented sources
- rhxterm.pdf: documentation
- aldor.el: Aldor mode for (X)Emacs
(optional)
- aldor.el.nw: documented sources
- aldor-mode.pdf: documentation
- framed.sty (version 0.8a): optional for colored background
- srcltx.sty (version 1.4, 1.5, 1.6): optional for an inverse search feature of newer dvi viewers, for example xdvik.
- ExtIO (version >= 1.0.2): optional for compilation of test suite.
- AldorUnit (version >= 1.0.3): necessary for compilation of test suite.
Here is the last version of ALLPROSE.
- allprose-0.2.5.tar.gz: complete sources of ALLPROSE (including the documentation)
- allprose-0.2.5.pdf.gz: documentation of ALLPROSE
- (online) documentation of ALLPROSE
- (online) documentation of the MyAlps sample project that comes with ALLPROSE
I have packaged ALLPROSE and all of the necessary files below for easier installation.
- Get packaged-allprose-0.2.5.tar.gz.
- Store it into a directory /my/own/dir.
- Extract by
gunzip -c packaged-allprose-0.2.5.tar.gz | tar xvpf - - cd packaged-allprose
- cat README
- Follow the steps from the README, it is short enough.