documentation-packages team mailing list archive

[Chris Perry <clissold345@xxxxxxxxxxxxxx>]

About 60 pages in the desktop help use <list> elements. (I listed them
using the command grep "<list" *.page.) Can I go through them and (where
possible) tidy up the help by putting in type="disc" (that's the bullet
style that we are using)? I was planning to do the changes manually -
not of course via a global replace - each time checking the html (but
not checking the page appearance using yelp).

Most of the uses of <list> seem straightforward. However, there's a
handful of unusual/complicated uses, which I may well leave alone. (If
in doubt, leave it alone.)

So far I've noticed three short procedures that have been wrongly marked
up using <list>, so I'm planning to change those too. They'll be changed
to <steps> elements.

I'll just be changing markup (not the English text) so there is (surely)
no impact on the translators. This is basically a simple job (though
there are 60 pages to check). Can anything go wrong?

-- 
You received this bug notification because you are a member of
Documentation Packages, which is subscribed to ubuntu-docs in Ubuntu.
https://bugs.launchpad.net/bugs/1649554

Title:
  Default Mallard <list> element translated incorrectly

Status in ubuntu-docs package in Ubuntu:
  Fix Committed

Bug description:
  When "type" is not specified in a Mallard <list> element the Mallard
  spec says it should display as a bulleted (unordered) list. This is
  true when the .page file is displayed using yelp but not when the
  .page file is translated into HTML (where you get a numbered list).
  This is a bug. The HTML should be displayed as specified by the
  Mallard spec.

  Here's an example <list> element without "type" specified.

  <list>
    <item><p><code>GTK_MESSAGE_INFO</code></p></item>
    <item><p><code>GTK_MESSAGE_WARNING</code></p></item>
    <item><p><code>GTK_MESSAGE_QUESTION</code></p></item>
    <item><p><code>GTK_MESSAGE_ERROR</code></p></item>
    <item><p><code>GTK_MESSAGE_OTHER</code></p></item>
  </list>

  Here's the link to the relevant page of the Mallard spec:

  http://projectmallard.org/1.0/mal_block_list

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/ubuntu-docs/+bug/1649554/+subscriptions