From portal-commits at lists.jboss.org Fri Oct 19 12:37:54 2007 Content-Type: multipart/mixed; boundary="===============5132263352797625881==" MIME-Version: 1.0 From: portal-commits at lists.jboss.org To: portal-commits at lists.jboss.org Subject: [portal-commits] JBoss Portal SVN: r8719 - in docs/template/user-guide/en: modules and 1 other directory. Date: Fri, 19 Oct 2007 12:37:54 -0400 Message-ID: --===============5132263352797625881== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: julien(a)jboss.com Date: 2007-10-19 12:37:54 -0400 (Fri, 19 Oct 2007) New Revision: 8719 Modified: docs/template/user-guide/en/master.xml docs/template/user-guide/en/modules/sample.xml Log: update the doc template to include what we should use to write well formate= d documentation (not exhaustive of course) Modified: docs/template/user-guide/en/master.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- docs/template/user-guide/en/master.xml 2007-10-19 15:42:38 UTC (rev 871= 8) +++ docs/template/user-guide/en/master.xml 2007-10-19 16:37:54 UTC (rev 871= 9) @@ -10,9 +10,9 @@ Change Release Info in master.xml Change Release Info Date in master.xml - Thomas - Heute - theute(a)jboss.org + Your first name + Your last name + your.email(a)your.domain.com Modified: docs/template/user-guide/en/modules/sample.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- docs/template/user-guide/en/modules/sample.xml 2007-10-19 15:42:38 UTC = (rev 8718) +++ docs/template/user-guide/en/modules/sample.xml 2007-10-19 16:37:54 UTC = (rev 8719) @@ -1,58 +1,205 @@ - + - Julien - Viet - julien.viet(a)jboss.com + Your first name + Your last name + your.email(a)your.domain.com - My title - This section covers the ajax features provided by the portal. + Sample chapter + This is the beginning of the sample chapter. - Introduction - Todo - - - Ajaxified markup + sample section + This is the beginning of the sample section. It contains examp= les of how docbook should be used in the context + of a documentation for a Java related product. + - Ajaxified layouts - Part of the Ajax capabilities are implemented in the layout= framework which provide the structure for - generating portal pages. The good news is that the existing layou= t only requires a few modifications in - order to be ajaxified. - We will use as example an simplified version of the layout = JSP provided in JBoss Portal 2.6 and outline - what are the required changes that makes it an ajaxified layout: + Bullet points - - - - - - - - - + + Item1 + Item2 + Item3 + ]]> + - ]]> = should be already present as it exists since 2.4 but is even more - necessary as it will inject in the page the reference to= the ajax stylesheet. - ]]> should be added before any other region - in the markup of the layout. - ]]> should be added after any other region - in the markup of the layout. + Item1 + Item2 + Item3 - - - - - - The portal providing partial refresh - - + + + Interface or annotation reference + mypackage.MyInterface +@MyAnnotation +]]> + + mypackage.MyInterface + @MyAnnotation + + + + + Class reference + mypackage.MyClass +]]> + + mypackage.MyClass + + + + + Parameter reference + MyParameter +]]> + + MyParameter + + + + + Method referece + myMethod() +]]> + + myMethod() + + + + + Exception reference + mypackage.MyException +]]> + + mypackage.MyException + + + + + A variable name + myVariable +]]> + + myVariable + + + + + File reference + MyFile +]]> + + MyFile + + + + + Literal reference + null +1 +"foo" +]]> + + null + 1 + "foo" + + + + + A constant + MAX_VALUE +]]> + + MAX_VALUE + + + + + Inline code + System.out.println() +]]> + + System.out.println() + + + + + Code or XML with a caption + +<example> + <programlisting><![CDATA[public class MyClass +{ +} +]]></programlisting> + <caption>This is the MyClass class</caption> +</example> + + + + + This is the MyClass class + + + + + + A database name + MyDatabase +]]> + + MyDatabase + + + + + A shell command + ls -l +]]> + + ls -l + + + + + A shell example + <![CDATA[julien-viets-computer:~/java/jboss-portal-template/use= r-guide julien$ ls -l +total 8 +drwxr-xr-x 3 julien julien 102 Oct 19 18:14 build +-rwxr-xr-x 1 julien julien 923 Oct 19 17:40 build.xml +drwxr-xr-x 6 julien julien 204 Oct 19 17:42 en +]]> +]]> + + + + + + --===============5132263352797625881==--