itstool improvements

[Shaun McCance <shaunm gnome org>]

Hi all,

I'm working on improvements to how itstool shows the path and
how it handles multiple comments. Currently, you get messages
like this:

#: backup-how.page:25(page/title)
msgid "How to back up"

I've had complaints that I really shouldn't be putting paths in
the source file marker, so I want to change it to something like
this:

#. # page/title
#: backup-how.page:25
msgid "How to back up"

I'm also working on improving how comments are handled. Currently,
you have to be very careful about what node you put a comment on
(or a "locNote" is ITS terminology). Consider this XML:

<item><p>This is a <em>sentence</em>.</p></item>

If I put its:locNote="some comment" on the <p> element, you'll see
it in the PO files. But you won't see it if I put it on the <item>
or <em> element. What's more, the its:locNote attribute completely
shadows comments from e.g. its:locNoteRule elements. I don't want
comments to get lost.

So given this XML:

<item its:locNote="comment for item">
  <p its:locNote="comment for p">This is a
  <em its:locNote="comment for em">sentence</em>.</p>
</item>

I'm thinking of outputting something like this:

#. # item/p
#.
#. ## ../item
#. comment for item
#.
#. ## item/p
#. comment for p
#.
#. ## item/p/em
#. comment for em
#: somefile.page:25
msgid ""
"This is a <em its:locNote=\"comment for em\">sentence</em>."

I'd like to get some feedback from users on how you think the best
way to convey the markers is. In the example here, I've used "#"
to indicate the path for the message, and "##" to indicate the path
for each comment, sort of as if they were headers and subheaders in
a markdown-like language. Ugly? Helpful? Stupid? Feedback please.

--
Shaun