← Back to team overview

ubuntu-manual team mailing list archive

Re: "status" tag


Hi, Jim.

On Wed, Aug 7, 2013 at 10:18 PM, Jim Connett <jimandmarcy@xxxxxxxxx> wrote:
> How are we wanting/needing to use the "status" tag in the sections of the
> manual? Is there a quick cheat-sheet available? I see this as a very useful
> tool during the development process, and I'd like to know how to use this
> tag so that the proper information can be communicated. I think Kevin
> produced something last iteration, but I can't seem to find it in my email.

The syntax for the \status command is as follows:


where version is the manual version number (e.g., 12.04, 12.04e2,
13.10); date is the date the status was updated in ISO 8601 format
(YYYY-MM-DD, e.g., 2013-08-07), and status is a keyword denoting the
status.  Example keywords from the Mallard schema are:

 * stub - contains little to no real content
 * incomplete - outline of all information, but lacking content
 * draft - all content available, but unpolished
 * outdated - was once complete or nearly complete, but needs to be
revised to reflect change
 * review - ready to be reviewed by editors
 * candidate - reviewed and awaiting a final approval
 * final - approved and ready for publication or distribution

We probably don't need to use most of those and I think it'd be a good
idea to settle on a small subset that encompass the status types that
we care about.

In particular, I'd like to know the following:
 * has the chapter/section has been touched since the last release?
 * is an author currently working on updating it?
 * is the author finished so the editor can start?
 * is an editor currently working on it?
 * is the editor finished and it's ready for public review?
 * have the public comments/bug fixes been incorporated and is it
ready for final publication?

We can steal any of the Mallard keywords we like, ignore any we don't
like, and make up our own.