#8315: Reference manual layout: toggles, sidebar links
-----------------------------+----------------------------------------------
Reporter: mpatel | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: minor | Milestone: sage-4.3.3
Component: documentation | Keywords:
Author: Mitesh Patel | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Changes (by newvalueoldvalue):
* cc: hivert, jhpalmiei, nthiery (added)
* status: new => needs_review
* milestone: => sage-4.3.3
* author: => Mitesh Patel
Old description:
> !JavaScript additions to `layout.html` that transform a reference manual
> HTML page on display.
>
> See [http://groups.google.com/group/sage-
> devel/browse_thread/thread/a34a80097ad47805/2e57eb60d7f9881d?#2e57eb60d7f9881d
> sage-devel] for some background.
New description:
We add potentially useful features to reference manual HTML pages:
* In the sidebar:
* Sticky sidebar toggle.
* Indented list of links to the page's classes, methods, functions.
* Controls to toggle, hide, or show docstrings.
* In the main content:
* Click on an argspec to toggle the corresponding docstring.
See [http://groups.google.com/group/sage-
devel/browse_thread/thread/a34a80097ad47805/2e57eb60d7f9881d?#2e57eb60d7f9881d
sage-devel] for some background.
--
Comment:
I've attached a first take. Remarks:
* I haven't tested this extensively.
* The sticky sidebar doesn't work in the live docs.
* All of the transformations are done in the browser when it renders the
page.
* Feel free to change the colors or suggest other changes!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8315#comment:1>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
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.
