Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!

Bug 100443

Summary: Change &emdash;&endash to —/– entities in GuideXML
Product: [OLD] Docs-developer Reporter: Alexey Chumakov (RETIRED) <achumakov>
Component: Guide XMLAssignee: Xavier Neys (RETIRED) <neysx>
Status: VERIFIED FIXED    
Severity: normal CC: docs-team
Priority: High    
Version: unspecified   
Hardware: All   
OS: Linux   
Whiteboard:
Package list:
Runtime testing required: ---
Attachments: book.dtd char entities fixed
guide.dtd char entities fixed
inserts.dtd char entities fixed
metadoc.dtd char entities fixed

Description Alexey Chumakov (RETIRED) gentoo-dev 2005-07-27 01:38:18 UTC
There was my proposal to add dash entities to guide.dtd etc.
I suggested (erroneously) two options to do that:
one was &emdash;, and the other was &mdash;
That was my mistake.

Right (and official) names are at http://www.w3.org/2003/entities/

Later on I found that &emdash or &endash is used rarely, but is confusing
instead: all of Xml Docbook/ Dita / XHTML / TEI etc use &mdash; and &ndash;
Xavier said it's irrelevant but it isn't: why introduce more chaos?
Anybody using it will have to remember: "Endash here, Ndash there, Mdash there,
Ndash here" :-)

Hopefully, nobody except myself had time to use that entities in real documents
at the moment!

PLEASE! Change &emdash to &mdash, and &endash to &ndash ASAP.
I'll then take care of forthcoming Russian docs.

I'll also found that characher entity declarations differ between DTDs where
they shouldn't. It is corrected, too.

Patches are encosed.
Comment 1 Alexey Chumakov (RETIRED) gentoo-dev 2005-07-27 01:39:02 UTC
Created attachment 64415 [details, diff]
book.dtd char entities fixed
Comment 2 Alexey Chumakov (RETIRED) gentoo-dev 2005-07-27 01:39:14 UTC
Created attachment 64416 [details, diff]
guide.dtd char entities fixed
Comment 3 Alexey Chumakov (RETIRED) gentoo-dev 2005-07-27 01:39:24 UTC
Created attachment 64417 [details, diff]
inserts.dtd char entities fixed
Comment 4 Alexey Chumakov (RETIRED) gentoo-dev 2005-07-27 01:39:34 UTC
Created attachment 64418 [details, diff]
metadoc.dtd char entities fixed
Comment 5 Jakub Moc (RETIRED) gentoo-dev 2005-07-27 01:42:40 UTC
*** Bug 100441 has been marked as a duplicate of this bug. ***
Comment 6 Xavier Neys (RETIRED) gentoo-dev 2005-07-27 02:21:26 UTC
(In reply to comment #0)
> Xavier said it's irrelevant but it isn't: why introduce more chaos?

You had stated only ndash was ok in html and that is irrelevant because those
entities are replaced and do not appear as an entity in html.
If you prefer ndash/mdash. I don't care. I'll change them provided no one else
has started using them.

> I'll also found that characher entity declarations differ between DTDs where
> they shouldn't. It is corrected, too.

You shouldn't have.
metadoc/inserts do not really need them. They are seldom changed and if you need
a "funky char", just type it.

As for the "missing' entities, they are not missing.
They were introduced into guide.dtd only because they have been used in a few
old files and it was more convenient to add them than to hunt for those files
and fix them and their invalid xml.

Only characters that are really very difficult or impossible to type should be
available as an entity.
In order:
Always use &nbsp; instead of ' ' because you can't 'see' them
Use the character itself, or its entity if you really can't ype it
Avoid (hexa)decimal entities that make the text difficult to read.
Comment 7 Xavier Neys (RETIRED) gentoo-dev 2005-07-27 02:30:41 UTC
e{m,n}dash replaced by {m,n}dash
Comment 8 Alexey Chumakov (RETIRED) gentoo-dev 2005-07-27 02:34:05 UTC
Thank you!