Opened 13 years ago

Closed 13 years ago

#8320 closed defect (fixed)

Make HTML doc headers and footers more compact

Reported by: Mitesh Patel Owned by: Minh Van Nguyen
Priority: trivial Milestone: sage-4.3.4
Component: documentation Keywords:
Cc: Merged in: sage-4.3.4.alpha0
Authors: Mitesh Patel Reviewers: Minh Van Nguyen
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by Mitesh Patel)

We can use Sphinx's html_short_title setting to [try to] keep links from overflowing the header and footer.

This could be useful for devices with small-screen or large fonts (e.g., for accessibility).

For example, instead of "Sage Reference Manual v4.3.3," we can use "Reference v4.3.3," which should help for deeply nested pages.

Attachments (2)

trac_8320-html_short_title.patch (1.7 KB) - added by Mitesh Patel 13 years ago.
HTML short titles for selected docs. sage repo.
trac_8320-reviewer.patch (1.4 KB) - added by Minh Van Nguyen 13 years ago.
apply on top of previous patch

Download all attachments as: .zip

Change History (6)

Changed 13 years ago by Mitesh Patel

HTML short titles for selected docs. sage repo.

comment:1 Changed 13 years ago by Mitesh Patel

Authors: Mitesh Patel
Description: modified (diff)
Milestone: sage-4.3.3
Priority: minortrivial
Status: newneeds_review

The patch adds shorter HTML titles, which appear in Sphinx headers and footers, for selected docs: the developer's guide, Bordeaux lectures, numerical primer, and reference manual. The others' titles overflow only with very large font sizes. But feel free to make adjustments, e.g., for consistency.

Changed 13 years ago by Minh Van Nguyen

Attachment: trac_8320-reviewer.patch added

apply on top of previous patch

comment:2 Changed 13 years ago by Minh Van Nguyen

Reviewers: Minh Van Nguyen

The reviewer patch trac_8320-reviewer.patch shortens the HTML title of these documents:

  • A Tour of Sage
  • Sage Installation Guide

I also changed the short title of the reference manual from "Reference" to "Sage Reference" as an attempt to be consistent with these short titles:

  • Sage Tutorial
  • Sage Constructions
  • Sage Tour

Only my patch needs review by anyone but me.

comment:3 Changed 13 years ago by Mitesh Patel

Status: needs_reviewpositive_review

comment:4 Changed 13 years ago by Minh Van Nguyen

Merged in: sage-4.3.4.alpha0
Resolution: fixed
Status: positive_reviewclosed
Note: See TracTickets for help on using tickets.