For documentation contributions, suggestions, improvements and translations

Sven Vermeulen | 29 Dec 2011 15:27

Updated date in handbook

Hi guys,

Something else I noticed is that we sometimes get questions in #gentoo or
even #gentoo-doc about the "Updated" date of the Gentoo Handbook(s). Because
of how things work, the displayed date on the handbook pages is always the
one that is for the given file.

In case of the index page, this is a somewhat old(er) version as the index
page hardly changes. Yet that is the "Updated" version most people look at.

Would it be okay if I updated doc-struct.xsl so that for handbooks, the
updated version always matches the latest update?

Other possibilities are:
- On the index page, display the latest update, but on individual chapters,
  keep the current used date
- Don't touch anything and stop harassing me with your suggestions

	Sven Vermeulen

headers

Matthew Summers | 29 Dec 2011 15:35

Re: Updated date in handbook

On Thu, Dec 29, 2011 at 8:27 AM, Sven Vermeulen <swift <at> gentoo.org> wrote:
> Hi guys,
>
> Something else I noticed is that we sometimes get questions in #gentoo or
> even #gentoo-doc about the "Updated" date of the Gentoo Handbook(s). Because
> of how things work, the displayed date on the handbook pages is always the
> one that is for the given file.
>
> In case of the index page, this is a somewhat old(er) version as the index
> page hardly changes. Yet that is the "Updated" version most people look at.
>
> Would it be okay if I updated doc-struct.xsl so that for handbooks, the
> updated version always matches the latest update?
>
> Other possibilities are:
> - On the index page, display the latest update, but on individual chapters,
>  keep the current used date
> - Don't touch anything and stop harassing me with your suggestions
>
>
>        Sven Vermeulen
>

Another option, although I hate to add it, would be always update the
date on the index page when anything gets updated. However that is
sort of silly. I support updating doc-struct.xsl

Cheers,
Matt
--

--

(Continue reading)

headers

Duncan | 29 Dec 2011 17:07

Re: Updated date in handbook

Sven Vermeulen posted on Thu, 29 Dec 2011 14:27:21 +0000 as excerpted:

> Something else I noticed is that we sometimes get questions in #gentoo
> or even #gentoo-doc about the "Updated" date of the Gentoo Handbook(s).
> Because of how things work, the displayed date on the handbook pages is
> always the one that is for the given file.
> 
> In case of the index page, this is a somewhat old(er) version as the
> index page hardly changes. Yet that is the "Updated" version most people
> look at.
> 
> Would it be okay if I updated doc-struct.xsl so that for handbooks, the
> updated version always matches the latest update?
> 
> Other possibilities are:
> - On the index page, display the latest update, but on individual
> chapters, keep the current used date

* What about simply prepending the single word "Page" to the existing 
"Updated <date>"?  Because lacking that, the current dates on the index 
pages really do look like they apply to the whole thing, while "Page 
Updated" is both clear enough and similar enough to the same mechanism as 
I've seen it on other sites, that it should go quite a way toward 
eliminating the confusion.

--

-- 
Duncan - List replies preferred.   No HTML msgs.
"Every nonfree program has a lord, a master --
and if you use the program, he is your master."  Richard Stallman

(Continue reading)