| Summary: | Add easily obtainable permalinks to the variables in the documentation | ||
|---|---|---|---|
| Product: | [Documentation] Reference | Reporter: | Laszlo Papp <lpapp> |
| Component: | handbook | Assignee: | Scott Rifenbark <srifenbark> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | enhancement | ||
| Priority: | Low | CC: | bluelightning, jefro, jessica.zhang, mhalstead, poky.doc.watcher, poky.watcher, ross.burton, srifenbark |
| Version: | unspecified | ||
| Target Milestone: | Future | ||
| Hardware: | x86 | ||
| OS: | Multiple | ||
| Whiteboard: | 25 June 2014: RESOLVED | ||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Done (doc changes complete) | |
|
Description
Laszlo Papp
2014-01-30 12:31:57 UTC
http://doccookbook.sourceforge.net/html/en/dbc.html.permalinks.html looks like it should do the job. Hi, I have been trying to implement this one and am running into some technical issues that I am having to go outside to "expert" circles from which to solicit help. There seems to be a issue with creating the permalinks for section names. I can do it for chapters and other items in the XML files but section names are currently giving me issues. I am seeking help in the docbook-apps mailing list, etc. to see if someone can help figure it out. Scott Hi, I have solved the technical issues surrounding the permalinks for sections and chapters. These versions of the manuals now have permalinks for all the chapters and section titles. http://www.yoctoproject.org/docs/1.7/adt-manual/adt-manual.html http://www.yoctoproject.org/docs/1.7/bsp-guide/bsp-guide.html http://www.yoctoproject.org/docs/1.7/dev-manual/dev-manual.html http://www.yoctoproject.org/docs/1.7/kernel-dev/kernel-dev.html http://www.yoctoproject.org/docs/1.7/profile-manual/profile-manual.html http://www.yoctoproject.org/docs/1.7/ref-manual/ref-manual.html http://www.yoctoproject.org/docs/1.7/yocto-project-qs/yocto-project-qs.html The mega-manual also has permalinks: http://www.yoctoproject.org/docs/1.7/mega-manual/mega-manual.html The BitBake manual also now has permalinks: http://www.yoctoproject.org/docs/1.7/bitbake-user-manual/bitbake-user-manual.html For the moment, I am now trying to solve the technical problem stopping me from creating permalinks on individual glossary terms. So, still in research/design mode for the bug. However, you can see section permalinks here. Thanks, Scott Hi, The final piece of this solution is complete. All docs have permalinks for each section heading. And, the Bitbake User Manual and YP Reference Manual additionally have permalinks for each variable description in the respective glossaries. Marking the bug RESOLVED and putting the doc flag to "Done". Scott So whilst this is a very useful addition, I think the permalink markers are a little distracting - would it be possible to tweak the stylesheet such that they only show up on hovering over the item, or perhaps make them less visible by making them grey instead of black? What Paul said - appearing in grey on hover sounds like a great compromise. I am not going to bother re-opening this. I will look into fixing how these display. Thanks, Scott Hi, Here is just the BB manual with some different styles for the permalinks. Let me know what you think. http://www.yoctoproject.org/docs/1.7/bitbake-user-manual/bitbake-user-manual.html Thanks, Scott Would it be possible to hide the anchor entirely when the title/reference isn't hovered, and then show it in a mid-grey? Oh, and add some left padding so it doesn't sit right up to the text. Works for me. Ross - I don't want to hide it entirely. It is barely visible right now. If you hide it completely then you don't know they are there unless you accidentally hover over it. I also don't think we need space in there. I am just leaving these as they are for now. Scott |