[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: description writing guide

On Wed, Dec 04, 2002 at 08:05:43PM -0500, Colin Walters wrote:
> I think this is hard to without switching to a format which allows us to
> include more metadata (like XML).  So we can explicitly use stuff like
> <ul> and <li> for lists, instead of relying on ASCII renderings.  That
> way we can safely word-wrap the description, instead of just treating it
> as the equivalent of <pre>.

The Description file used to have such a format.  It had enough information
to allow word-wrapping, a specified format for bulleted lists, and a way
to add meta-information (even though no such information was yet defined).

Sadly, it seems to have been lost.  I can't find a description of the
Description format anywhere in the current policy manual; not even in
the version of the Packaging Manual that it carries as an appendix.

Hmm, D.2.7 says the description is in "a special format", but does
not say what that format is, and refers to a section that does not
describe it.

Richard Braakman

Reply to: