 News |
FAQ
|
| Search
|
Home
|
| Getting Started | Documentation | Glish | Learn More | Programming | Contact Us |
|
| Version 1.9 Build 803 |
|
The Recipes Repository consists of two parts. First, the recipes themselves are to be checked in as well-commented glish scripts (see above for details of the required format) in code/contrib/recipes. The build system copies the scripts to libexec so that they may be accessed directly.
The second part of the Repository is the documentation of each recipe. The directory structure for the documentation is as follows:
| code/doc/recipes | root directory for Recipe docs |
| code/doc/recipes/Recipes.latex | LATEX markup for main Recipes web-page |
| code/doc/recipes/makefile | makefile for Recipes.latex |
| code/doc/recipes/index.html | forwarding html for main Recipes web-page |
| code/doc/recipes/General/ | directory for General recipes markup |
| code/doc/recipes/General/General.latex | LATEX markup for General category web-page |
| code/doc/recipes/General/makefile | makefile for General recipes |
| code/doc/recipes/General/index.html | forwarding html for General category web-page |
| code/doc/recipes/Synthesis/ | directory for Synthesis recipes markup |
| code/doc/recipes/Synthesis/Synthesis.latex | LATEX markup for Synthesis category web-page |
| code/doc/recipes/Synthesis/makefile | makefile for Synthesis recipes |
| code/doc/recipes/Synthesis/index.html | forwarding html for Synthesis category web-page |
| code/doc/recipes/SingleDish/ | directory for SingleDish recipes markup |
| code/doc/recipes/SingleDish/SingleDish.latex | LATEX markup for SingleDish category web-page |
| code/doc/recipes/SingleDish/makefile | makefile for SingleDish recipes |
| code/doc/recipes/SingleDish/index.html | forwarding html for SingleDish category web-page |
The LATEX markup file for each recipe (see above for details of the required format) is to be deposited into the markup directory appropriate to the recipe's category. The LATEX markup file for the category should be updated with the recipe name and title, and the appropriate line added to the category's makefile. The build system will then process the recipe's LATEX markup file and generate .ps.gz and html files in the appropriate locations in the docs tree.