| Summary: | Incorrect dash characters used in manual | ||
|---|---|---|---|
| Product: | [Documentation] Development Manual | Reporter: | Paul Eggleton <bluelightning> |
| Component: | development | Assignee: | Scott Rifenbark <srifenbark> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | Undecided | ||
| Version: | 1.7 | ||
| Target Milestone: | --- | ||
| Hardware: | All | ||
| OS: | Multiple | ||
| Whiteboard: | 27 April 2015: RESOLVED | ||
| OS type for building Yocto: | --- | Type of Regression: | New (Never tested) |
| Verified: | Documentation change: | Yes (doc changes required) | |
|
Description
Paul Eggleton
2015-03-03 14:02:03 UTC
hmm... yes, I have used ‐‐ in the Docbook source because during development of sections, sometimes I need to comment out stuff, which requires a block such as the following:
<!--
comments
comments
comments
-->
Anytime a literal '--' character appears in the commented block, it causes a problem when making the manual. I guess I can just use the ‐ stuff during debugging and when the manual making correctly, replace with literall dash characters.
Scott
I scrubbed the manuals and none of these strings remain. Manuals affected include the dev-manual and the ref-manual. Scott I'd be interested to know where this ‐ entity is being substituted - is it in the browser or when the HTML is produced by the documentation tools? If the latter, it might be fixable. Pretty sure that the ENTITY stuff is substituted by the tools. Which totally doesn't make sense as to why when a person copies a command from an HTML doc it has issues. Scott Here is the docbook source for the code in question:
<literallayout class='monospaced'>
# smart channel ‐‐add all type=rpm-md baseurl=http://server.name/rpm/all
# smart channel ‐‐add i585 type=rpm-md baseurl=http://server.name/rpm/i586
# smart channel ‐‐add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86
</literallayout>
When I bring up the HTML version of the manual and select the first smart channel --add command and then "view source", this is what I get.
<pre class="literallayout"> # smart channel ‐‐add all type=rpm-md baseurl=http://server.name/rpm/all
# smart channel ‐‐add i585 type=rpm-md baseurl=http://server.name/rpm/i586
# smart channel ‐‐add qemux86 type=rpm-md baseurl=http://server.name/rpm/qemux86
</pre>
Note the "--" strings are in there.
OK, so I had a look at: http://www.oasis-open.org/docbook/specs/wd-docbook-xmlcharent-0.3.html It seems to suggest that ‐ should indeed give you the unicode character we are getting and the correct entity for the normal "-" would be ‐ . Can you give that a try? I tried &hypen; out. Go to http://www.yoctoproject.org/docs/1.8/dev-manual/dev-manual.html#runtime-package-management-target-rpm and see if you can cut out that command without any issues. Scott This is still broken in the current manual - the "smart channel" commands are apparently still using the wrong dash characters. I have universally replaced all the "‐" strings in the YP docs with the "-" string. This should no longer be an issue. There were many occurrences in the dev-manual and a few occurrences in the ref-manual. I pushed the commit to both the 'master' and 'fido' branches in 'yocto-docs'. I have republished the 'current' and 'latest' set of docs to the server so everything thing should be good with this issue. Scott |