| Summary: | [PATCH] take static part of pgpkeys out of localised handbooks | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Documentation | Reporter: | Siebrand Mazeland <s.mazeland> | ||||
| Component: | Books & Articles | Assignee: | Remko Lodder <remko> | ||||
| Status: | Closed FIXED | ||||||
| Severity: | Affects Only Me | ||||||
| Priority: | Normal | ||||||
| Version: | Latest | ||||||
| Hardware: | Any | ||||||
| OS: | Any | ||||||
| Attachments: |
|
||||||
|
Description
Siebrand Mazeland
2006-01-02 00:00:19 UTC
bvs@ mentioned that share/pgpkeys/README should also be patch, hence the added diff. Index: share/pgpkeys/README =================================================================== RCS file: /home/ncvs/doc/share/pgpkeys/README,v retrieving revision 1.1 diff -u -r1.1 README --- share/pgpkeys/README 8 May 2003 09:48:38 -0000 1.1 +++ share/pgpkeys/README 6 Jan 2006 19:27:00 -0000 @@ -26,11 +26,9 @@ | Adding key to entity list... | | Unless you are already listed there, you should now add the -| following text to -| usr/doc/en_US.ISO8859-1/books/handbook/pgpkeys/chapter.sgml in the -| appropriate position in -| the developer section (unless this is a role key or you are a -| core member.) Remember to keep the list sorted by last name! +| following text to pgpkeys-developers.sgml (unless this is a role key +| or you are a core member. In that case add to pgpkeys-officers.sgml +| or pgpkeys-core.sgml). Remember to keep the list sorted by last name! | | <sect2 id="pgpkey-des"> | <title>&a.des;</title> http://www.freebsd.org/cgi/query-pr.cgi?pr=91192 On Mon, Jan 02, 2006, Siebrand Mazeland wrote:
>
> >Description:
> Currently pgpkeys/chapter.sgml contains a lot of 'static' content that is copied
> in each and every localised version of the handbook. As changes are often made
> to this chapter, keeping up to date for non English translations is a time
> consuming and uninspirational task. As the blocks of entities should be exactly
> the same in every localised version, I suggest to take the static parts out of
> the handbook and place them in share/. Thus the pgp keyblocks can be included
> in the localised versions without having to sacrifice the parts of the chapter
> that should be translated. See below for patches and what was changed where.
> >How-To-Repeat:
> Check contents of handbook/pgpkeys/chapter.sgml for two languages and observe
> the overlap:
> http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/handbook/pgpkeys/chapter.sgml?rev=1.285&content-type=text/x-cvsweb-markup
> http://www.freebsd.org/cgi/cvsweb.cgi/doc/nl_NL.ISO8859-1/books/handbook/pgpkeys/chapter.sgml?rev=1.10&content-type=text/x-cvsweb-markup
> >Fix:
> 1. take the static parts out of chapter.sgml and create 3 seperate files in
> /doc/share/pgpkeys/ called pgpkeys-core.sgml, pgpkeys-developers.sgml, and
> pgpkeys-officers.sgml
> 2. create 3 new entities in /doc/share/pgpkeys/pgpkeys.ent pointing to the
> newly created files
> 3. add the entities to the localised version of handbook/pgpkeys/chapter.sgml
> (done for en_US.ISO8859-1 in the patch)
> 4. patch /doc/share/pgpkeys/addkey.sh to conform to the new structure.
>
> .....
> .....
I read this patch and have no objections.
English and Russian versions of handbook are builded normally with these changes.
Vitaly
Responsible Changed From-To: freebsd-doc->remko Till now i saw no objections from anyone, multiple people agreed so far so i will start working on integrating this. State Changed From-To: open->closed I just committed the patch to the FreeBSD cvs repro. The changes should be visible within 24 hours. Thanks for the submission !! |