Ticket #3109 (new enhancement)

Opened 3 months ago

Last modified 3 months ago

Improve manual for 1.6

Reported by: pdmef Owned by: pdmef
Priority: minor Milestone: 1.6
Component: doc Version: 1.5.18
Keywords: patch Cc: vincent@…

Description

The manual still has lots and lots of inconsistencies in style and markup (e.g. markup for function names). These should be revisited to make it ready for 1.6. If possible, we should also add a section on typographic conventions (if not, we should define them in this ticket to fix inconsistencies).

Attachments

mutt-css.diff (2.3 kB) - added by pdmef 3 months ago.
Simple and clean CSS stylesheet for manual

Change History

Changed 3 months ago by Rocco Rutte <pdmef@…>

(In [6fd1fa2d98bc]) Manual: fix/improve markup/content, see #3109

Changed 3 months ago by vinc17

  • cc vincent@… added

There are errors in doc/manual.xml.head:

  • eiter -> either
  • won't be send -> won't be sent
  • without having to needing -> without having to need
  • if does exist already -> if it does exist already

And shouldn't RFC822 be replaced by RFC2822?

In the "Pattern modifiers" section, there are inconsistencies between the singular and the plural (e.g. ~b vs ~e).

Also, there's something missing here:

<varlistentry>
<term></term>
<listitem><para></para></listitem>
</varlistentry>

Changed 3 months ago by Rocco Rutte <pdmef@…>

(In [a2fc5e7c77ae]) Manual: Fix style and typos. Noted by Vincent Lefevre, see #3109.

Changed 3 months ago by pdmef

It would be really nice if we could find an english native speaker going over the manual and fixing grammar and/or punctuation before 1.6 and after all changes are made.

Changed 3 months ago by pdmef

Simple and clean CSS stylesheet for manual

Changed 3 months ago by pdmef

  • keywords patch added
Note: See TracTickets for help on using tickets.