287414 - Use entities to describe menus and dialogs in help documentation

Status: NEW

(SeaMonkey :: Help Documentation, defect)

Description

[Ian Neal]

See bug 247595 for details but this is something that could be useful for the
Suite as well.

Comment 1

[Giacomo Magnini]

Attachment: Example of what we are trying to archive.

Comment 2

[Stefan [:stefanh]]

Hmm, would it be better to use entities for the entries in help-toc and
help-index1 instead/also? We could then move those files to /content. Using
entities in those files would also ensure that entries in .rdf files and
headings in xhtml files match. The issues I can think of is the readability and
that the amount of entities could affect loading time (guessing).

Thoughts?

Comment 3

[Robert Kaiser]

(In reply to comment #2)
> Hmm, would it be better to use entities for the entries in help-toc and
> help-index1 instead/also? We could then move those files to /content. Using
> entities in those files would also ensure that entries in .rdf files and
> headings in xhtml files match. The issues I can think of is the readability and
> that the amount of entities could affect loading time (guessing).

Actually, that might even help more than the stuff here (which is a nice idea
though as well), as those .rdf are nasty for translation compared to some DTDs ;-)

Should be a different bug though, IMO.

Comment 4

[Stefan [:stefanh]]

The problem is when someone installs/build the suite without one component. For
instance, not installing Composer will produce errors in the Composer files that
are in Help.