Refactor preface

Mark Craig

26.48.2012 e50bcbc8685a2c63458116b53f444e4cc9dfaeb0

Refactor preface

 opendj-sdk/opendj3/src/main/docbkx/admin-guide/preface.xml

@@ -60,98 +60,7 @@
  started with this guide, and then learn more as you go along.</para>
 </section>

 <section>
  <title>Using Samples</title>

  <para>This work is licensed under the <link
  xlink:href="http://creativecommons.org/licenses/by-nc-nd/3.0/"
  >Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported
  License</link>.</para>

  <para>See the license for the specific language governing permissions and
  limitations under the license.</para>
 </section>

 <section>
  <title>Formatting Conventions</title>

  <note><para>Pay attention to notes like this one.</para></note>

  <para>Some items might be formatted differently from other text, like
  <filename>filenames</filename>, <command>commands</command>, and
  <literal>literal values</literal>.</para>

  <screen>$ echo Terminal sessions are formatted like this.
Terminal sessions are formatted like this.</screen>

  <programlisting language='java'>class Test
{
    public static void main(String [] args)
    {
        System.out.println("This is a program listing.");
    }
}</programlisting>

  <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD,
  and so forth are marked (UNIX). Sections pertaining to Microsoft Windows
  might be marked (Windows). To avoid repetition, however, file system
  directory names are often given only in UNIX format as in
  <filename>/path/to/OpenDJ</filename>, even if the text applies to
  <filename>C:\path\to\OpenDJ</filename> as well.</para>

  <warning><para>Ignore warnings at your own risk.</para></warning>
 </section>

 <section>
  <title>Accessing OpenDJ Documentation Online</title>

  <para>Core documentation, such as what you are now reading, aims to
  be technically accurate and complete with respect to the software
  documented. Core documentation therefore follows a <link
  xlink:href='https://wikis.forgerock.org/confluence/display/devcom/Review+Process'
  >three-phase review process</link> designed to eliminate errors. The
  review process should slow authors down enough that documentation you get
  with a stable release has had time to bake fully.</para>

  <!-- TODO: online location of core documentation, perhaps docs.forgerock.org? -->
  <para>Fully baked core documentation is available at <link
  xlink:href='http://...'>...</link>.</para>

  <para>The <link xlink:show="new"
  xlink:href="https://wikis.forgerock.org/confluence/display/OPENDJ">OpenDJ
  Wiki</link> regularly brings you more, fresh content. In addition, you are
  welcome to <link xlink:show="new"
  xlink:href="https://idp.forgerock.org/openam/UI/Login?service=register">sign
  up</link> and then edit the Wiki if you notice an error, or if you have
  something to share.</para>
 </section>

 <section>
  <title>Joining the OpenDJ Community</title>

  <para>After you <link
  xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
  >sign up</link> at ForgeRock, you can also login to the Wiki and the issue
  database to follow what is happening with the project.</para>

  <para>If you have questions regarding OpenDJ which are not answered by the
  documentation, there is a mailing list which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj'
  >https://lists.forgerock.org/mailman/listinfo/opendj</link> where you are
  likely to find an answer.</para>

  <para>You can join the IRC discussion in the #opendj room at
  irc.freenode.net.</para>

  <para>The Wiki has information on how to check out OpenDJ source code.
  There is also a mailing list for OpenDJ development which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj-dev'
  >https://lists.forgerock.org/mailman/listinfo/opendj-dev</link>
  Should you want to contribute a patch, test, or feature, or want to author
  part of the core documentation, first have a look on the ForgeRock Community
  page at <link xlink:href='http://www.forgerock.org/get_involved.html'>
  how to get involved</link>.</para>
 </section>

 <xinclude:include href="../shared/sec-formatting-conventions.xml" />
 <xinclude:include href="../shared/sec-accessing-doc-online.xml" />
 <xinclude:include href="../shared/sec-joining-the-community.xml" />
</preface>


 opendj-sdk/opendj3/src/main/docbkx/dev-guide/preface.xml

@@ -51,98 +51,7 @@
  started with this guide, and then learn more as you go along.</para>
 </section>

 <section>
  <title>Using Samples</title>

  <para>This work is licensed under the <link
  xlink:href="http://creativecommons.org/licenses/by-nc-nd/3.0/"
  >Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported
  License</link>.</para>

  <para>See the license for the specific language governing permissions and
  limitations under the license.</para>
 </section>

 <section>
  <title>Formatting Conventions</title>

  <note><para>Pay attention to notes like this one.</para></note>

  <para>Some items might be formatted differently from other text, like
  <filename>filenames</filename>, <command>commands</command>, and
  <literal>literal values</literal>.</para>

  <screen>$ echo Terminal sessions are formatted like this.
Terminal sessions are formatted like this.</screen>

  <programlisting language='java'>class Test
{
    public static void main(String [] args)
    {
        System.out.println("This is a program listing.");
    }
}</programlisting>

  <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD,
  and so forth are marked (UNIX). Sections pertaining to Microsoft Windows
  might be marked (Windows). To avoid repetition, however, file system
  directory names are often given only in UNIX format as in
  <filename>/path/to/OpenDJ</filename>, even if the text applies to
  <filename>C:\path\to\OpenDJ</filename> as well.</para>

  <warning><para>Ignore warnings at your own risk.</para></warning>
 </section>

 <section>
  <title>Accessing OpenDJ Documentation Online</title>

  <para>Core documentation, such as what you are now reading, aims to
  be technically accurate and complete with respect to the software
  documented. Core documentation therefore follows a <link
  xlink:href='https://wikis.forgerock.org/confluence/display/devcom/Review+Process'
  >three-phase review process</link> designed to eliminate errors. The
  review process should slow authors down enough that documentation you get
  with a stable release has had time to bake fully.</para>

  <!-- TODO: online location of core documentation, perhaps docs.forgerock.org? -->
  <para>Fully baked core documentation is available at <link
  xlink:href='http://...'>...</link>.</para>

  <para>The <link xlink:show="new"
  xlink:href="https://wikis.forgerock.org/confluence/display/OPENDJ">OpenDJ
  Wiki</link> regularly brings you more, fresh content. In addition, you are
  welcome to <link xlink:show="new"
  xlink:href="https://idp.forgerock.org/openam/UI/Login?service=register">sign
  up</link> and then edit the Wiki if you notice an error, or if you have
  something to share.</para>
 </section>

 <section>
  <title>Joining the OpenDJ Community</title>

  <para>After you <link
  xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
  >sign up</link> at ForgeRock, you can also login to the Wiki and the issue
  database to follow what is happening with the project.</para>

  <para>If you have questions regarding OpenDJ which are not answered by the
  documentation, there is a mailing list which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj'
  >https://lists.forgerock.org/mailman/listinfo/opendj</link> where you are
  likely to find an answer.</para>

  <para>You can join the IRC discussion in the #opendj room at
  irc.freenode.net.</para>

  <para>The Wiki has information on how to check out OpenDJ source code.
  There is also a mailing list for OpenDJ development which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj-dev'
  >https://lists.forgerock.org/mailman/listinfo/opendj-dev</link>
  Should you want to contribute a patch, test, or feature, or want to author
  part of the core documentation, first have a look on the ForgeRock Community
  page at <link xlink:href='http://www.forgerock.org/get_involved.html'>
  how to get involved</link>.</para>
 </section>

 <xinclude:include href="../shared/sec-formatting-conventions.xml" />
 <xinclude:include href="../shared/sec-accessing-doc-online.xml" />
 <xinclude:include href="../shared/sec-joining-the-community.xml" />
</preface>


 opendj-sdk/opendj3/src/main/docbkx/install-guide/preface.xml

@@ -67,98 +67,7 @@
  started with this guide, and then learn more as you go along.</para>
 </section>

 <section>
  <title>Using Samples</title>

  <para>This work is licensed under the <link
  xlink:href="http://creativecommons.org/licenses/by-nc-nd/3.0/"
  >Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported
  License</link>.</para>

  <para>See the license for the specific language governing permissions and
  limitations under the license.</para>
 </section>

 <section>
  <title>Formatting Conventions</title>

  <note><para>Pay attention to notes like this one.</para></note>

  <para>Some items might be formatted differently from other text, like
  <filename>filenames</filename>, <command>commands</command>, and
  <literal>literal values</literal>.</para>

  <screen>$ echo Terminal sessions are formatted like this.
Terminal sessions are formatted like this.</screen>

  <programlisting language='java'>class Test
{
    public static void main(String [] args)
    {
        System.out.println("This is a program listing.");
    }
}</programlisting>

  <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD,
  and so forth are marked (UNIX). Sections pertaining to Microsoft Windows
  might be marked (Windows). To avoid repetition, however, file system
  directory names are often given only in UNIX format as in
  <filename>/path/to/OpenDJ</filename>, even if the text applies to
  <filename>C:\path\to\OpenDJ</filename> as well.</para>

  <warning><para>Ignore warnings at your own risk.</para></warning>
 </section>

 <section>
  <title>Accessing OpenDJ Documentation Online</title>

  <para>Core documentation, such as what you are now reading, aims to
  be technically accurate and complete with respect to the software
  documented. Core documentation therefore follows a <link
  xlink:href='https://wikis.forgerock.org/confluence/display/devcom/Review+Process'
  >three-phase review process</link> designed to eliminate errors. The
  review process should slow authors down enough that documentation you get
  with a stable release has had time to bake fully.</para>

  <!-- TODO: online location of core documentation, perhaps docs.forgerock.org? -->
  <para>Fully baked core documentation is available at <link
  xlink:href='http://...'>...</link>.</para>

  <para>The <link xlink:show="new"
  xlink:href="https://wikis.forgerock.org/confluence/display/OPENDJ">OpenDJ
  Wiki</link> regularly brings you more, fresh content. In addition, you are
  welcome to <link xlink:show="new"
  xlink:href="https://idp.forgerock.org/openam/UI/Login?service=register">sign
  up</link> and then edit the Wiki if you notice an error, or if you have
  something to share.</para>
 </section>

 <section>
  <title>Joining the OpenDJ Community</title>

  <para>After you <link
  xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
  >sign up</link> at ForgeRock, you can also login to the Wiki and the issue
  database to follow what is happening with the project.</para>

  <para>If you have questions regarding OpenDJ which are not answered by the
  documentation, there is a mailing list which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj'
  >https://lists.forgerock.org/mailman/listinfo/opendj</link> where you are
  likely to find an answer.</para>

  <para>You can join the IRC discussion in the #opendj room at
  irc.freenode.net.</para>

  <para>The Wiki has information on how to check out OpenDJ source code.
  There is also a mailing list for OpenDJ development which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj-dev'
  >https://lists.forgerock.org/mailman/listinfo/opendj-dev</link>
  Should you want to contribute a patch, test, or feature, or want to author
  part of the core documentation, first have a look on the ForgeRock Community
  page at <link xlink:href='http://www.forgerock.org/get_involved.html'>
  how to get involved</link>.</para>
 </section>

 <xinclude:include href="../shared/sec-formatting-conventions.xml" />
 <xinclude:include href="../shared/sec-accessing-doc-online.xml" />
 <xinclude:include href="../shared/sec-joining-the-community.xml" />
</preface>


 opendj-sdk/opendj3/src/main/docbkx/shared/sec-accessing-doc-online.xml

New file
@@ -0,0 +1,53 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !
-->
 <section xml:id="accessing-doc-online"
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <title>Accessing OpenDJ Documentation Online</title>

 <para>Core documentation, such as what you are now reading, aims to
 be technically accurate and complete with respect to the software
 documented. Core documentation therefore follows a <link xlink:show="new"
 xlink:href='https://wikis.forgerock.org/confluence/display/devcom/Review+Process'
 >three-phase review process</link> designed to eliminate errors. The
 review process should slow authors down enough that documentation you get
 with a stable release has had time to bake fully.</para>

 <!-- TODO: online location of core documentation, perhaps docs.forgerock.org? -->
 <para>Fully baked core documentation is available at <link
 xlink:href='http://...'>...</link>.</para>

 <para>The <link xlink:show="new"
 xlink:href="https://wikis.forgerock.org/confluence/display/OPENDJ">OpenDJ
 Wiki</link> regularly brings you more, fresh content. In addition, you are
 welcome to <link xlink:show="new"
 xlink:href="https://idp.forgerock.org/openam/UI/Login?service=register">sign
 up</link> and then edit the Wiki if you notice an error, or if you have
 something to share.</para>
</section>

 opendj-sdk/opendj3/src/main/docbkx/shared/sec-formatting-conventions.xml

New file
@@ -0,0 +1,64 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !
-->
 <section xml:id="formatting-conventions"
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <title>Formatting Conventions</title>

 <para>Some items are formatted differently from other text, like
 <filename>filenames</filename>, <command>commands</command>, and
 <literal>literal values</literal>.</para>

 <screen>
$ echo Terminal sessions with very long lines are formatted with lines folded
 by default to make them easier to read on the screen and to make them fit
 on the printed page. In the HTML version, you can double-click the text to
 toggle between the folded version for easy reading and the flat, syntactically
 correct version for easy copy/pasting.
Terminal sessions with very long lines are formatted with lines folded
 by default to make them easier to read on the screen and to make them fit
 on the printed page. In the HTML version, you can double-click the text to
 toggle between the folded version for easy reading and the flat, syntactically
 correct version for easy copy/pasting.</screen>

 <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD,
 and so forth are marked (UNIX). Sections pertaining to Microsoft Windows
 might be marked (Windows). To avoid repetition, however, file system
 directory names are often given only in UNIX format as in
 <filename>/path/to/OpenDJ</filename>, even if the text applies to
 <filename>C:\path\to\OpenDJ</filename> as well.</para>

 <programlisting language='java'>class Test
{
    public static void main(String [] args)
    {
        System.out.println("This is a program listing.");
    }
}</programlisting>
</section>

 opendj-sdk/opendj3/src/main/docbkx/shared/sec-joining-the-community.xml

New file
@@ -0,0 +1,56 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !
-->
 <section xml:id="joining-the-community"
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <title>Joining the OpenDJ Community</title>

 <para>After you <link
 xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
 >sign up</link> at ForgeRock, you can also login to the Wiki and the issue
 database to follow what is happening with the project.</para>

 <para>If you have questions regarding OpenDJ which are not answered by the
 documentation, there is a mailing list which can be found at
 <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj'
 >https://lists.forgerock.org/mailman/listinfo/opendj</link> where you are
 likely to find an answer.</para>

 <para>You can join the IRC discussion in the #opendj room at
 irc.freenode.net.</para>

 <para>The Wiki has information on how to check out OpenDJ source code.
 There is also a mailing list for OpenDJ development which can be found at
 <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj-dev'
 >https://lists.forgerock.org/mailman/listinfo/opendj-dev</link>
 Should you want to contribute a patch, test, or feature, or want to author
 part of the core documentation, first have a look on the ForgeRock Community
 page at <link xlink:href='http://www.forgerock.org/get_involved.html'>
 how to get involved</link>.</para>
</section>