simplifying <articleinfo> and <bookinfo> sections

[Richard Johnson]

On Sunday 03 December 2006 12:38, Matthew East wrote:
> While playing around in the topic-based-help branch, I thought that if
> we're going to have a lot of different documents, it would be convenient
> to have a simpler more automated way of writing <articleinfo> and
> <bookinfo> sections.
>
> Instead of writing them for each document, we can simply call entities
> which bring up the same thing each time. See how it works here:
>
> https://docteam.ubuntu.com/repos/branches/topic-based-help/ubuntu/C/add-app
>lications/add-applications.xml
>
> What do people think about standardising these sections for *all* of our
> documents in this way? We could have a standard list of contributors for
> all documents (common/C/contributors.xml) which is called for all the
> documents. The disadvantage is that the reader doesn't get to see who
> works on each individual document, but the advantage is its simpler to
> implement documents and that everyone is credited for their contribution
> to {*}Ubuntu documentation, regardless of where they contributed.
>
> Matt

Definately creates cleaner code which is nice when you are working through a 
document. Less to scroll to in order to get to the work at hand. To fix the 
disadvantage, the contributors list could list information for each author to 
display a small background on the work they do/have done, if people want to 
let others know what they have done.

+1 here

-- 
.:Richard Johnson
.:nixternal at ubuntu.com
.:ubuntu.com .:kubuntu.com .:edubuntu.com .:xubuntu.com
.:http://nixternal.ubuntu-rocks.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20061203/4b7fc9e7/attachment.pgp>