Bug 755174 Help Document Lots in Account window

[goodvibes2]

No description provided.

[jralls]

Chris,
Looks pretty good aside from the two inline comments.

[jralls]

The resize pointer is a graphic cursor that looks vaguely like <—> only on Linux and possibly only with some themes. On a Mac it's more like <-|-> and on Windows <-||->. It looks like that on the vertical bar; on the horizontal bar the arrows point up and down and the |s on Mac and Windows are horizontal. I think it would be best to inline the above image as well as this one and say that they're examples and that they might look a bit different depending on theme and OS, but I don't know how well that will work out.

[goodvibes2]

Did you have something in mind how to 'inline' this? I don't remember seeing anything like this in the help or guide. I see there is a docbook inlinemediaobject http://docbook.org/tdg5/en/html/inlinemediaobject.html which I could try out. I'm tempted to just say it's the horizontal or vertical resize pointer (terminology I've seen on Windows) which looks something like a double ended arrow depending on your OS and theme.
inlinemediaobject is not used in the guide or help at the moment.

[jralls]

If it's too hard to do the inline image then sure, yield to temptation. It's not worth much time or effort.

[goodvibes2]

I found the inlinemediaobject works (html, pdf & mobi) but the images don't lineup well with the text.
I have add the 2 graphic cursor images you pointed me too as examples at the end of the paragraph.

[jralls]

I see you've fallen in love with em-dashes. They shouldn't have spaces around them and using them at the beginning of a sentence like that isn't really appropriate, see http://www.thepunctuationguide.com/em-dash.html. While you're there you should study up on n-dashes and hyphens so that you know when to use each correctly. That aside, it's also inconsistent with the rest of the manual where a colon is (more correctly) used.

[goodvibes2]

I was just following Help, Setting Preferences where it is used many times. I don't really like the look of many colons but using a table is too much typing and too visually distracting. I'll change to colons.

[jralls]

So I looked a bit deeper: A bit of grepping reveals that there are 98 instances that use &mdash; (all incorrectly wrapped with spaces), 157 that use ':' (4 after the </guilabel> and the rest as part of the label), and 194 that use only a space. I think we should change them all to ':' as part of the label so that the colon gets the guilabel styling—not all of them as part of this PR of course, just the ones it adds.

[goodvibes2]

OK I'll do that before I resubmit a new PR to replace this.

[jralls]

I don't think you need to submit a new PR. Just make the changes, do a git commit --amend, and force-push (git push --force github bug755174DocViewLotsHelp) and this PR should automagically update.

[goodvibes2]

Just to be clear, no guimenu/guimenuitem?

[jralls]

I suppose to be pedantically correct it should be <guimenuitem> instead of <guilabel>, but I think both tags render the same so it doesn't really matter for our purposes.

[goodvibes2]

Unfortunately "title" is needed for List of Figures so I see no point in adding caption here.
Also unfortunately, the title is all bold in html, pdf & mobi (same as guilabel and guimenuitem). I'm going with:

        <title>The <guimenuitem>Preferences</guimenuitem> window,
          <guilabel>Accounting Period</guilabel> tab
        </title>

[goodvibes2]

Should the mdash mods for guide be a different commit than help mdash mods?

[jralls]

Doesn't really matter as long as emdash mods are the only changes in the commit(s).

[goodvibes2]

I see we could also just use:
<guimenuitem>Preferences</guimenuitem><guilabel>Accounting Period</guilabel>
That sort of sidesteps the mac or Linux/Win issue for this case.

[goodvibes2]

Mods finished and force pushed to my GitHub.

[jralls]

Thanks.