| 1 |
Xavier Neys wrote: |
| 2 |
> Of course, users reading a 2004.3 handbook should realise it's old, but they |
| 3 |
> could at least be told it's not maintained anymore so that 1) they can read it |
| 4 |
> with a grain of salt 2) they should not bother submitting bugs. |
| 5 |
|
| 6 |
IMHO that's against what SwifT said about fixing? |
| 7 |
|
| 8 |
> Dumping the text in the doc itself is not a great idea as it will lead to |
| 9 |
> cut'n'paste errors and lose consistency. Besides, scripts could not distinguish |
| 10 |
> normal content from such disclaimers. |
| 11 |
|
| 12 |
Yep. |
| 13 |
|
| 14 |
> Another way would have been to list the outdated/unmaintained docs in an |
| 15 |
> external file, or add attributes to metadoc. IMO, this adds some unnecessary |
| 16 |
> complexity. |
| 17 |
|
| 18 |
External file would look mroe elegant to me, but that's just me. |
| 19 |
|
| 20 |
> I much prefer something along Flammie's idea, a new tag. This way, we just need |
| 21 |
> to add the tag to the relevant doc and forget about it. |
| 22 |
> |
| 23 |
> As we already see the need for different disclaimers, I suggest using a |
| 24 |
> <disclaimer> tag with a type attribute. The relevant text is fished from our |
| 25 |
> inserts.xml files and I suggest displaying it right at the top of the content |
| 26 |
> area. It needs to be either before, after or on the side, but I'd rather not |
| 27 |
> insert it randomly in the text. |
| 28 |
|
| 29 |
Seems great. |
| 30 |
|
| 31 |
> Now about outdated translations: |
| 32 |
> It's possible to use metadoc to check the corresponding original and display a |
| 33 |
> note about a more recent original. |
| 34 |
|
| 35 |
That would be great. |
| 36 |
|
| 37 |
> I've implemented the following: |
| 38 |
> If a translation is not listed in its local metadoc, warn users translation is |
| 39 |
> not maintained. |
| 40 |
> If a translation is listed in its local metadoc, but not in the parent one (ie. |
| 41 |
> the English one), warn users original doc is not maintained anymore. |
| 42 |
> If file appears both in local and English metadocs, compare their dates and warn |
| 43 |
> users that a more recent original exists with a link to it. |
| 44 |
|
| 45 |
Well, as I said on IRC, I'd prefer checking <version>, but <date> is |
| 46 |
also better than nothing, yep (code which would check <version>s of HB |
| 47 |
files is not available). |
| 48 |
|
| 49 |
Cheers, |
| 50 |
-jkt |
| 51 |
|
| 52 |
-- |
| 53 |
cd /local/pub && more beer > /dev/mouth |
Archives