5. The Sage Manuals

This chapter describes how to modify the Sage manuals. Sage's manuals are written in LaTeX, and to edit them, you just need to edit the appropriate file.

If, for example, you want to change the Sage tutorial, then you should start by modifying the file SAGE_ROOT/devel/doc/tut/tut.tex. Then to build a dvi or pdf file with your changes, type ./build_dvi or ./build_pdf in the devel/doc/tut directory. You'll get a file tut.dvi or tut.pdf, which you should inspect. You should also run sage -t tut.tex to test all of the examples - see Section 2.5. You can build an HTML version of the tutorial by typing make tut in the devel/doc directory. Once you've done this, you can access the new HTML version from the notebook interface to Sage by clicking the Help link.

Finally, you might want to share your changes with the Sage community. To do this, use Mercurial (see Chapter 7) to produce patch files, and submit them to the Sage trac server.

The Sage manuals and the corresponding files to edit:

The Sage tutorial: SAGE_ROOT/devel/doc/tut/tut.tex
The Sage developer's guide: SAGE_ROOT/devel/doc/prog/prog.tex
Constructions in Sage: SAGE_ROOT/devel/doc/const/const.tex
The Sage installation guide: SAGE_ROOT/devel/doc/inst/inst.tex
The Sage reference manual: some of this is contained in the file SAGE_ROOT/devel/doc/ref/ref.tex, but most of it is automatically generated from the Sage source code. See the file SAGE_ROOT/devel/doc/ref/README.txt for information about how to edit the reference manual.

See About this document... for information on suggesting changes.