Date: Tue, 27 Nov 2012 22:03:41 +0100 From: =?ISO-8859-1?Q?Ren=E9_Ladan?= <rene@freebsd.org> To: FBSD Doc project <doc@FreeBSD.org> Subject: [RFC] (partial) patch to clean up authors.ent / developers.ent duplication Message-ID: <50B52AAD.7030004@freebsd.org>
next in thread | raw e-mail | index | archive | help
Hi, we currently have two files in our documentation tree for committer entries (i.e., &a.committer-name; ): share/xml/authors.ent and share/xml/developers.ent, as indicated at [1]. Worse, in authors.ent the entities have an email address included hile in developers.ent they do not. I have a (partial) patch at [2] to merge these two files and unify the meaning of these entities. Currently it: - merges developers.ent into authors.ent (some names changed slightly, e.g., "Simon L. Nielsen" to "Simon L. B. Nielsen", because they differed between these two files); - redefine &a.committer-name; not having an email address and &a.committer-name.email; to have one; - replace (Docbook) references to developers.ent with authors.ent; - removes developers.ent; - add some people with @FreeBSD.org addresses and a FreeBSD account to authors.ent, and use these in the English articles instead; - removes the instruction to add your entity to developers.ent from the Committer's Guide article; - renames some team entities to avoid conflicts resulting in unexpected output; - updates all English articles to ensure their output does not change otherwise (mostly changing &a.committer-name; to &a.committer-name.email; ); - updates instructions in addkey.sh and README and the key listings in share/pgpkeys; - replaces (most) web pages to use the more readable form to list teams as proposed in [1]; - remove a duplicate and out of date team.re entity from share/xml/teams.ent. Todo: - fix the WWW build, currently there is no DSL code to transform <email> tags into some href code (maybe this can be copied from the doc build); - modify the English books to make sure their output remains the same; - make sure the translations still build; - agree on what to do about the translations, their output will change until their XML sources are resynchronized with their English counterparts. Personally I am in favor of leaving this up to the translation teams to avoid interfering with their work; - Maybe transform some more literal names into entities; - Probably some other minor cleanups (like line rewrapping in a second commit). Not-todo: - change literal occurrences of "FreeBSD" to "&os;"; - change entities for accented letters into their literal form; - remove old content; - unrelated XML/igor/spelling fixes. Questions: - Maybe this should go in a branch first (especially when it is decided to include the translations)? - There is no ds@ , although the current documentation somewhat suggests he has an account? - The 2005 and 2006 editions of the Summer of Code pages include email addresses, while the 2007 and 2008 versions do not? [1] http://lists.freebsd.org/pipermail/freebsd-doc/2012-November/020720.html [2] http://people.freebsd.org/~rene/patches/head-entities.diff (yes, 11,120 lines and growing) René
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?50B52AAD.7030004>