Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 64051 - Printable documents not easy to get or not really printable.
Summary: Printable documents not easy to get or not really printable.
Status: RESOLVED DUPLICATE of bug 64052
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All All
: High normal (vote)
Assignee: Docs Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2004-09-14 14:07 UTC by Xavier Neys (RETIRED)
Modified: 2005-07-17 13:06 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Xavier Neys (RETIRED) gentoo-dev 2004-09-14 14:07:07 UTC
Up to now, users had to append ?style=printable to URLs to get a printable version of documents. This not user-friendly. Handbook pages show a "print" item in the navbar, why should they be an exception?
Users have no way of knowing whether a doc is printable (only <guide> and <book> are), it is clumsy and some printable docs do not even yield a printable version even with ?style=printable because guide.xsl has been hardcoded into the .xml

Dr. X has the cure ;-)

1) Making All Printable Docs Really Printable

Testing style==printable before calling either guide.xsl or guide-print.xsl is pointless. guide.xsl needs to test it again anyway and any .xml explicitely using guide.xsl cannot become printable. All we need is 1 (one) test in guide.xsl to get rid of guide-print.xsl. handbook.xsl can be made simpler as well because it does not need to test the style at all.
I have made guide-print.xsl trivial, it has to be available until the AxKit config has been updated to not reference it anymore.

2) Giving Users Easy Access to Printable Versions

To let users get a printable versions of a doc, the friendliest way is IMHO to put a "Print" button on printable pages. See http://dev.gentoo.org/~neysx/tests/gentoolkit.html for an example.
All <guide> and <book> are printable, but to display the link, the stylesheet needs the link attribute in <guide> or <book>.
I suggest making the link attribute #REQUIRED instead of #IMPLIED in the DTDs.
_ALL_ books already have the link attribute and it should have been made compulsory anyway because the navbar already relies on it.
The GWN and very few <guide> docs are missing it. I can fix most, not the GWN though.
The GWN guys would need to specify the link attribute in upcoming newsletters, old ones can be left as is (no link attribute==no print button==no change from current situation) or can be updated if the GWN guys want to.
The few other docs that would need an attribute link on their next commit are:
./proj/en/base/sparc/obpreference.xml:<guide>
./proj/en/desktop/research/manifest.xml:<guide>
./proj/en/desktop/research/config_tools_reqs.xml:<guide>
./proj/en/desktop/research/meeting_reports.xml:<guide>
./proj/en/desktop/science/hpc_annonce.xml:<guide>
./proj/en/releng/status/status_20040607.xml:<guide>

This not asking too much IMHO.
Comment 1 Xavier Neys (RETIRED) gentoo-dev 2004-09-14 14:14:16 UTC
If b.g.o hadn't had a hiccup...

*** This bug has been marked as a duplicate of 64052 ***