preface.xml revision d1a1c16f546ed980d06b400fe4f7a0c050740c52
<?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
! 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
! 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 ForgeRock AS
!
-->
<preface xml:id='preface'
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>Preface</title>
<para>This reference covers how OpenIDM services fit together, how they work,
how they are configured, and the interfaces they provide.</para>
<section>
<title>Who Should Use this Reference</title>
<para>This reference is written for identity management designers and
administrators who build, deploy, and maintain OpenIDM services for
their organizations.</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>
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>C:\path\to\OpenIDM</filename> as well.</para>
<warning><para>Ignore warnings at your own risk.</para></warning>
</section>
<section>
<title>Accessing OpenIDM 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
>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>You need not wait until the core documentation is finished, though,
to read more about OpenIDM, and also to read about related topics that
involve OpenIDM without being strictly about OpenIDM. The <link
brings you more, fresh content. In addition, you are welcome to <link
>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 OpenIDM Community</title>
<para>After you <link
>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 OpenIDM which are not answered by the
documentation, there is a mailing list which can be found at
>https://lists.forgerock.org/mailman/listinfo/openidm</link> where you are
likely to find an answer.</para>
<para>The Wiki has information on how to check out OpenIDM source code.
There is also a mailing list for OpenIDM development which can be found at
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 site
involved</link>.</para>
</section>
</preface>