Opened 9 years ago

Closed 9 years ago

#47305 closed defect (fixed)

A variety of docbook dcoumentation corrections and style fixes

Reported by: grimreaper (Eitan Adler) Owned by: Ionic (Mihai Moldovan)
Priority: Normal Milestone:
Component: guide Version: 2.3.3
Keywords: haspatch Cc: larryv (Lawrence Velázquez)
Port:

Description

This makes a number of changes

  • changes "the the" the "the
  • changes "that that" to "that"
  • moves closing </para> tags around <itemlists> to where they belong
  • adds commas after "i.e." and "e.g." (since this was inconsistent prior)
  • removes duplicate words such as "file" after <file> and "command" after <command>
  • avoids using "e.g.," where plain english is better
  • avoids using "you" or "your" where possible
  • avoids "invoke" where "run" is better
  • capitalizes titles

and misc other changes

I apologize for making this one large diff

Attachments (1)

various-docbook-fixes.diff (36.3 KB) - added by grimreaper (Eitan Adler) 9 years ago.
a collection of docbook fixes

Download all attachments as: .zip

Change History (7)

comment:1 Changed 9 years ago by Ionic (Mihai Moldovan)

Owner: changed from markd@… to ionic@…
Status: newassigned

Changed 9 years ago by grimreaper (Eitan Adler)

Attachment: various-docbook-fixes.diff added

a collection of docbook fixes

comment:2 Changed 9 years ago by grimreaper (Eitan Adler)

updated ticket to fix additional issues:

  • all listitems must have <para> as their immediate child
  • filename must not have emphasis (but replaceable is okay)

comment:3 Changed 9 years ago by larryv (Lawrence Velázquez)

Cc: larryv@… added; ionic@… removed

I'll try to work through this soon, if Mihai doesn't get around to it.

comment:4 in reply to:  3 Changed 9 years ago by Ionic (Mihai Moldovan)

And he spoke: 'Have mercy on your Developer, for tasks are plentiful, but time meager.'

-- Ionic 4:2

comment:5 Changed 9 years ago by larryv (Lawrence Velázquez)

If you get to this before I do, I'd suggest breaking it up into separate commits for spelling/grammar mistakes, missing punctuation, markup errors, etc. (granularity at your discretion).

comment:6 Changed 9 years ago by Ionic (Mihai Moldovan)

Resolution: fixed
Status: assignedclosed
  • capitalization in r134581
  • grammar related to e.g. and i.e. in r134582 (+ replacing i.e. with e.g. where appropriate)
  • removed redundant wording for stuff already wrapped up in markup like <command> in r134583
  • deduplicated words words in r134584
  • <para> tag fixes in r134585
  • <emphasis> to <replaceable> in r134586
  • indentation and whitespaces in r134587 (+ a lot of other stuff that was not included in the original submitted diff)
  • OSX to OS X in r134588 (not part of this diff.)
Note: See TracTickets for help on using tickets.