From lightguard.jp at gmail.com Mon Feb 28 19:18:06 2011
Content-Type: multipart/mixed; boundary="===============9139012112923834656=="
MIME-Version: 1.0
From: Jason Porter <lightguard.jp at gmail.com>
To: seam-dev at lists.jboss.org
Subject: Re: [seam-dev] Module documentation
Date: Mon, 28 Feb 2011 17:17:45 -0700
Message-ID: <AANLkTi=KNau7be6e1xi+onyeQ8arUueoxvhEW1wBLULD@mail.gmail.com>
In-Reply-To: 4D5AF68E.60006@redhat.com

--===============9139012112923834656==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Another great reference to look at is
http://hudson.jboss.org/hudson/job/JBoss_Documentation_Guide/lastSuccessful=
Build/artifact/JBoss_Documentation_Guide/target/docbook/publish/en-US/html/=
index.html

On Tue, Feb 15, 2011 at 14:56, Shane Bryzak <sbryzak(a)redhat.com> wrote:
> To assist with the bundled documentation build, could everyone please
> ensure that you prefix your docbook id tags with the name of your
> module. =C2=A0This is unfortunately necessary as docbook requires unique =
ID
> values and will fail otherwise. =C2=A0To illustrate what I mean, let's
> pretend that two of our modules, faces and security both have
> introduction chapters:
>
> <chapter id=3D"introduction">
> <title>Seam Faces - Introduction</title>
> ...
>
>
>
> <chapter id=3D"introduction">
> <title>Seam Security - Introduction</title>
> ...
>
>
> Since both chapters have an id of "introduction", docbook fails when
> attempting to build the bundled docs. =C2=A0To workaround this restrictio=
n,
> we can simply add the module name:
>
>
> <chapter id=3D"faces-introduction">
> <title>Seam Faces - Introduction</title>
> ...
>
>
>
> <chapter id=3D"security-introduction">
> <title>Seam Security - Introduction</title>
> ...
>
>
> Can you also please apply the same naming standard to the docbook source
> files, and chapter titles (this will help to keep the bundled
> documentation more consistent).
>
> Lastly, if you need to add a new chapter to your module documentation
> (or rename an existing one), can you please let one of the core team
> devs know. =C2=A0Our bundled documentation build has its own master.xml f=
ile
> containing all the individual chapters from each module, and new
> chapters need to be manually added to this file [1]. =C2=A0Alternatively,=
 you
> can make the modification yourself and send a pull request.
>
> Thanks,
> Shane
>
> [1]
> https://github.com/seam/dist/blob/master/docs/src/main/docbook/en-US/mast=
er.xml
>
> _______________________________________________
> seam-dev mailing list
> seam-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/seam-dev
>



-- =

Jason Porter
http://lightguard-jp.blogspot.com
http://twitter.com/lightguardjp

Software Engineer
Open Source Advocate

PGP key id: 926CCFF5
PGP key available at: keyserver.net, pgp.mit.edu


--===============9139012112923834656==--