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

Bug#525843: support for encoding long descriptions using a "standard" text-based markup language

On Fri, Sep 11, 2009 at 08:00:41PM -0500, Manoj Srivastava wrote:
>         So, here is my take on a subset that needs to be supported in
>  policy (I do not think we need titles, don't you agree?)

I agree, we don't want titles.

>  a) Unordered lists use asterisks, pluses, and hyphens — interchangeably
>     — as list markers.
>  b) Ordered lists use numbers followed by periods. 
>     1) The numbers need not be i sequence -- but  you should still start
>        the list with the number 1.
>     2) The numbers need to be in sequence -- but may use #. instead to
>        get auto numbering.
>  c) List markers typically start at the left margin, but may be indented
>     by up to three spaces. List markers must be followed by one or more
>     spaces or a tab.
>  d) A hyperlink reference may directly embed a target URI inline, within
>     angle brackets: <http://www.debian.org>

I'm not sure hyperlinks are needed either.

>  e) nested lists are created by indenting the nested list
>     1) by at least 4 spaces, or 
>     2) have a blank line above, and line up with the previous
>        paragraph.
>  f) List items may consist of multiple paragraphs. Each subsequent
>     paragraph in a list item must
>     1)  have its first line indented by at least 4 spaces, or
>     2)  must line up with the paragraph above, relative to the bullet
>         marker
>  g) Emphasis is provided by surrounding the text with '*'. Like
>     *emphasis*. Stronger emphasis is provided by doubling the '*' --
>     like **strong**.

I definitely don't want to see people starting to abuse package descriptions
by using emphasis markup.  Package descriptions should stand on their own
without pretty fonts. :)

Steve Langasek                   Give me a lever long enough and a Free OS
Debian Developer                   to set it on, and I can move the world.
Ubuntu Developer                                    http://www.debian.org/
slangasek@ubuntu.com                                     vorlon@debian.org

Attachment: signature.asc
Description: Digital signature

Reply to: