#5555: [with patch, not ready for review] make some TeX macros available to
docstrings
---------------------------+------------------------------------------------
Reporter: jhpalmieri | Owner: jhpalmieri
Type: enhancement | Status: new
Priority: minor | Milestone: sage-3.4.1
Component: documentation | Keywords:
---------------------------+------------------------------------------------
With the attached patch, you should be able to use \ZZ, \CC, \RR, and \QQ
in docstrings and have them typeset correctly in the html, live html,
latex, and pdf versions of the documentation. To add new macros, edit the
file '$SAGE_ROOT/devel/sage/doc/common/sage-macros.tex'. (I considered
just using the existing file 'macros.tex' in the same directory, but
decided it was too bloated.)
The point here is to be able to write docstrings which are readable from
interactive help in Sage and which also get typeset correctly in the
reference manual; this was discussed on [http://groups.google.com/group
/sage-devel/browse_frm/thread/74e6bcf5ef716d1c sage-devel], and people
seemed to agree that a docstring like
{{{
This computes the integral homology `H_d(X, \ZZ)` of `X` in dimension `d`.
}}}
was better than
{{{
This computes the integral homology `H_d(X, \mathbb{Z})` of `X` in
dimension `d`.
}}}
especially since the \ZZ gets turned into ZZ when pre-parsed for
interactive help.
This point should be kept in mind if anyone wants to add new macros: the
name should be short and unambiguous, and there should be a good reason
for using it instead of plain LaTeX. (This was maybe what I meant when I
said that macros.tex was too bloated.)
Having said all of that, I would be happy to add some more macros now.
What else should be added? Once we seem to have made some sort of
decision about that, I'll update the patch and mark this ticket as "needs
review".
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5555>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en
-~----------~----~----~----~------~----~------~--~---
