Moved docs to new subproject
BIN
doc/docbook/images/admons/blank.png
Normal file
|
After Width: | Height: | Size: 374 B |
BIN
doc/docbook/images/admons/caution.gif
Normal file
|
After Width: | Height: | Size: 743 B |
BIN
doc/docbook/images/admons/caution.png
Normal file
|
After Width: | Height: | Size: 1.2 KiB |
BIN
doc/docbook/images/admons/caution.tif
Normal file
BIN
doc/docbook/images/admons/draft.png
Normal file
|
After Width: | Height: | Size: 17 KiB |
BIN
doc/docbook/images/admons/home.gif
Normal file
|
After Width: | Height: | Size: 321 B |
BIN
doc/docbook/images/admons/home.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
doc/docbook/images/admons/important.gif
Normal file
|
After Width: | Height: | Size: 1003 B |
BIN
doc/docbook/images/admons/important.png
Normal file
|
After Width: | Height: | Size: 722 B |
BIN
doc/docbook/images/admons/important.tif
Normal file
BIN
doc/docbook/images/admons/next.gif
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
doc/docbook/images/admons/next.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
doc/docbook/images/admons/note.gif
Normal file
|
After Width: | Height: | Size: 580 B |
BIN
doc/docbook/images/admons/note.png
Normal file
|
After Width: | Height: | Size: 490 B |
BIN
doc/docbook/images/admons/note.tif
Normal file
BIN
doc/docbook/images/admons/prev.gif
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
doc/docbook/images/admons/prev.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
doc/docbook/images/admons/tip.gif
Normal file
|
After Width: | Height: | Size: 598 B |
BIN
doc/docbook/images/admons/tip.png
Normal file
|
After Width: | Height: | Size: 449 B |
BIN
doc/docbook/images/admons/tip.tif
Normal file
BIN
doc/docbook/images/admons/toc-blank.png
Normal file
|
After Width: | Height: | Size: 318 B |
BIN
doc/docbook/images/admons/toc-minus.png
Normal file
|
After Width: | Height: | Size: 259 B |
BIN
doc/docbook/images/admons/toc-plus.png
Normal file
|
After Width: | Height: | Size: 264 B |
BIN
doc/docbook/images/admons/up.gif
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
doc/docbook/images/admons/up.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
doc/docbook/images/admons/warning.gif
Normal file
|
After Width: | Height: | Size: 743 B |
BIN
doc/docbook/images/admons/warning.png
Normal file
|
After Width: | Height: | Size: 1.2 KiB |
BIN
doc/docbook/images/admons/warning.tif
Normal file
BIN
doc/docbook/images/callouts/1.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/1.png
Normal file
|
After Width: | Height: | Size: 329 B |
BIN
doc/docbook/images/callouts/10.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/10.png
Normal file
|
After Width: | Height: | Size: 361 B |
BIN
doc/docbook/images/callouts/11.gif
Normal file
|
After Width: | Height: | Size: 244 B |
BIN
doc/docbook/images/callouts/11.png
Normal file
|
After Width: | Height: | Size: 565 B |
BIN
doc/docbook/images/callouts/12.gif
Normal file
|
After Width: | Height: | Size: 244 B |
BIN
doc/docbook/images/callouts/12.png
Normal file
|
After Width: | Height: | Size: 617 B |
BIN
doc/docbook/images/callouts/13.gif
Normal file
|
After Width: | Height: | Size: 244 B |
BIN
doc/docbook/images/callouts/13.png
Normal file
|
After Width: | Height: | Size: 623 B |
BIN
doc/docbook/images/callouts/14.gif
Normal file
|
After Width: | Height: | Size: 244 B |
BIN
doc/docbook/images/callouts/14.png
Normal file
|
After Width: | Height: | Size: 411 B |
BIN
doc/docbook/images/callouts/15.gif
Normal file
|
After Width: | Height: | Size: 244 B |
BIN
doc/docbook/images/callouts/15.png
Normal file
|
After Width: | Height: | Size: 640 B |
BIN
doc/docbook/images/callouts/2.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/2.png
Normal file
|
After Width: | Height: | Size: 353 B |
BIN
doc/docbook/images/callouts/3.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/3.png
Normal file
|
After Width: | Height: | Size: 350 B |
BIN
doc/docbook/images/callouts/4.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/4.png
Normal file
|
After Width: | Height: | Size: 345 B |
BIN
doc/docbook/images/callouts/5.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/5.png
Normal file
|
After Width: | Height: | Size: 348 B |
BIN
doc/docbook/images/callouts/6.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/6.png
Normal file
|
After Width: | Height: | Size: 355 B |
BIN
doc/docbook/images/callouts/7.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/7.png
Normal file
|
After Width: | Height: | Size: 344 B |
BIN
doc/docbook/images/callouts/8.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/8.png
Normal file
|
After Width: | Height: | Size: 357 B |
BIN
doc/docbook/images/callouts/9.gif
Normal file
|
After Width: | Height: | Size: 968 B |
BIN
doc/docbook/images/callouts/9.png
Normal file
|
After Width: | Height: | Size: 357 B |
BIN
doc/docbook/images/logo.gif
Normal file
|
After Width: | Height: | Size: 22 KiB |
BIN
doc/docbook/images/logo.psd
Normal file
4016
doc/docbook/index.xml
Normal file
488
doc/docbook/styles/fo/docbook.xsl
Normal file
@@ -0,0 +1,488 @@
|
||||
<?xml version="1.0"?>
|
||||
|
||||
<!--
|
||||
|
||||
This is the XSL FO configuration file for the Hibernate
|
||||
Reference Documentation. It defines a custom titlepage and
|
||||
the parameters for the A4 sized PDF printable output.
|
||||
|
||||
It took me days to figure out this stuff and fix most of
|
||||
the obvious bugs in the DocBook XSL distribution, so if you
|
||||
use this stylesheet, give some credit back to the Hibernate
|
||||
project.
|
||||
|
||||
christian.bauer@bluemars.de
|
||||
-->
|
||||
|
||||
<!DOCTYPE xsl:stylesheet [
|
||||
<!ENTITY db_xsl_bak "docbook-bak.xsl">
|
||||
<!ENTITY admon_gfx_path "../images/admons/">
|
||||
]>
|
||||
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||
version="1.0"
|
||||
xmlns="http://www.w3.org/TR/xhtml1/transitional"
|
||||
xmlns:fo="http://www.w3.org/1999/XSL/Format"
|
||||
exclude-result-prefixes="#default">
|
||||
|
||||
<xsl:import href="&db_xsl_bak;"/>
|
||||
|
||||
<!--###################################################
|
||||
Custom Title Page
|
||||
################################################### -->
|
||||
|
||||
<xsl:template name="book.titlepage.recto">
|
||||
<fo:block>
|
||||
<fo:table table-layout="fixed" width="175mm">
|
||||
<fo:table-column column-width="175mm"/>
|
||||
<fo:table-body>
|
||||
<fo:table-row>
|
||||
<fo:table-cell text-align="center">
|
||||
<fo:block>
|
||||
<fo:external-graphic src="file:images/logo.gif"/>
|
||||
</fo:block>
|
||||
<fo:block font-family="Helvetica" font-size="22pt" padding-before="10mm">
|
||||
<xsl:value-of select="bookinfo/subtitle"/>
|
||||
</fo:block>
|
||||
<fo:block font-family="Helvetica" font-size="12pt" padding="10mm">
|
||||
<xsl:value-of select="bookinfo/releaseinfo"/>
|
||||
</fo:block>
|
||||
</fo:table-cell>
|
||||
</fo:table-row>
|
||||
<fo:table-row>
|
||||
<fo:table-cell text-align="center">
|
||||
<fo:block font-family="Helvetica" font-size="14pt" padding="10mm">
|
||||
<xsl:value-of select="bookinfo/pubdate"/>
|
||||
</fo:block>
|
||||
</fo:table-cell>
|
||||
</fo:table-row>
|
||||
<fo:table-row>
|
||||
<fo:table-cell text-align="center">
|
||||
<fo:block font-family="Helvetica" font-size="12pt" padding="10mm">
|
||||
<xsl:text>Copyright (c) 2004 - </xsl:text>
|
||||
<xsl:for-each select="bookinfo/authorgroup/author">
|
||||
<xsl:if test="position() > 1">
|
||||
<xsl:text>, </xsl:text>
|
||||
</xsl:if>
|
||||
<xsl:value-of select="firstname"/>
|
||||
<xsl:text> </xsl:text>
|
||||
<xsl:value-of select="surname"/>
|
||||
</xsl:for-each>
|
||||
</fo:block>
|
||||
<fo:block font-family="Helvetica" font-size="10pt" padding="1mm">
|
||||
<xsl:value-of select="bookinfo/legalnotice"/>
|
||||
</fo:block>
|
||||
</fo:table-cell>
|
||||
</fo:table-row>
|
||||
</fo:table-body>
|
||||
</fo:table>
|
||||
</fo:block>
|
||||
</xsl:template>
|
||||
|
||||
<!-- Prevent blank pages in output -->
|
||||
<xsl:template name="book.titlepage.before.verso">
|
||||
</xsl:template>
|
||||
<xsl:template name="book.titlepage.verso">
|
||||
</xsl:template>
|
||||
<xsl:template name="book.titlepage.separator">
|
||||
</xsl:template>
|
||||
|
||||
<!--###################################################
|
||||
Header
|
||||
################################################### -->
|
||||
|
||||
<!-- More space in the center header for long text -->
|
||||
<xsl:attribute-set name="header.content.properties">
|
||||
<xsl:attribute name="font-family">
|
||||
<xsl:value-of select="$body.font.family"/>
|
||||
</xsl:attribute>
|
||||
<xsl:attribute name="margin-left">-5em</xsl:attribute>
|
||||
<xsl:attribute name="margin-right">-5em</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<!--###################################################
|
||||
Custom Footer
|
||||
################################################### -->
|
||||
|
||||
<!-- This footer prints the version number on the left side -->
|
||||
<xsl:template name="footer.content">
|
||||
<xsl:param name="pageclass" select="''"/>
|
||||
<xsl:param name="sequence" select="''"/>
|
||||
<xsl:param name="position" select="''"/>
|
||||
<xsl:param name="gentext-key" select="''"/>
|
||||
|
||||
<xsl:variable name="Version">
|
||||
<xsl:choose>
|
||||
<xsl:when test="//releaseinfo">
|
||||
<xsl:text>Acegi Security System for Spring </xsl:text><xsl:value-of select="//releaseinfo"/>
|
||||
</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<!-- nop -->
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:choose>
|
||||
<xsl:when test="$sequence='blank'">
|
||||
<xsl:choose>
|
||||
<xsl:when test="$double.sided != 0 and $position = 'left'">
|
||||
<xsl:value-of select="$Version"/>
|
||||
</xsl:when>
|
||||
|
||||
<xsl:when test="$double.sided = 0 and $position = 'center'">
|
||||
<!-- nop -->
|
||||
</xsl:when>
|
||||
|
||||
<xsl:otherwise>
|
||||
<fo:page-number/>
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:when>
|
||||
|
||||
<xsl:when test="$pageclass='titlepage'">
|
||||
<!-- nop: other titlepage sequences have no footer -->
|
||||
</xsl:when>
|
||||
|
||||
<xsl:when test="$double.sided != 0 and $sequence = 'even' and $position='left'">
|
||||
<fo:page-number/>
|
||||
</xsl:when>
|
||||
|
||||
<xsl:when test="$double.sided != 0 and $sequence = 'odd' and $position='right'">
|
||||
<fo:page-number/>
|
||||
</xsl:when>
|
||||
|
||||
<xsl:when test="$double.sided = 0 and $position='right'">
|
||||
<fo:page-number/>
|
||||
</xsl:when>
|
||||
|
||||
<xsl:when test="$double.sided != 0 and $sequence = 'odd' and $position='left'">
|
||||
<xsl:value-of select="$Version"/>
|
||||
</xsl:when>
|
||||
|
||||
<xsl:when test="$double.sided != 0 and $sequence = 'even' and $position='right'">
|
||||
<xsl:value-of select="$Version"/>
|
||||
</xsl:when>
|
||||
|
||||
<xsl:when test="$double.sided = 0 and $position='left'">
|
||||
<xsl:value-of select="$Version"/>
|
||||
</xsl:when>
|
||||
|
||||
<xsl:otherwise>
|
||||
<!-- nop -->
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:template>
|
||||
|
||||
<!--###################################################
|
||||
Custom Toc Line
|
||||
################################################### -->
|
||||
|
||||
<!-- The default DocBook XSL TOC printing is seriously broken... -->
|
||||
<xsl:template name="toc.line">
|
||||
<xsl:variable name="id">
|
||||
<xsl:call-template name="object.id"/>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:variable name="label">
|
||||
<xsl:apply-templates select="." mode="label.markup"/>
|
||||
</xsl:variable>
|
||||
|
||||
<!-- justify-end removed from block attributes (space problem in title.markup) -->
|
||||
<fo:block end-indent="{$toc.indent.width}pt"
|
||||
last-line-end-indent="-{$toc.indent.width}pt"
|
||||
white-space-treatment="preserve"
|
||||
white-space-collapse="false">
|
||||
<fo:inline keep-with-next.within-line="always">
|
||||
<!-- print Chapters in bold style -->
|
||||
<xsl:choose>
|
||||
<xsl:when test="local-name(.) = 'chapter'">
|
||||
<xsl:attribute name="font-weight">bold</xsl:attribute>
|
||||
</xsl:when>
|
||||
</xsl:choose>
|
||||
<fo:basic-link internal-destination="{$id}">
|
||||
<xsl:if test="$label != ''">
|
||||
<xsl:copy-of select="$label"/>
|
||||
<fo:inline white-space-treatment="preserve"
|
||||
white-space-collapse="false">
|
||||
<xsl:value-of select="$autotoc.label.separator"/>
|
||||
</fo:inline>
|
||||
</xsl:if>
|
||||
<xsl:apply-templates select="." mode="title.markup"/>
|
||||
</fo:basic-link>
|
||||
</fo:inline>
|
||||
<fo:inline keep-together.within-line="always">
|
||||
<xsl:text> </xsl:text>
|
||||
<fo:leader leader-pattern="dots"
|
||||
leader-pattern-width="3pt"
|
||||
leader-alignment="reference-area"
|
||||
keep-with-next.within-line="always"/>
|
||||
<xsl:text> </xsl:text>
|
||||
<fo:basic-link internal-destination="{$id}">
|
||||
<fo:page-number-citation ref-id="{$id}"/>
|
||||
</fo:basic-link>
|
||||
</fo:inline>
|
||||
</fo:block>
|
||||
</xsl:template>
|
||||
|
||||
<!--###################################################
|
||||
Extensions
|
||||
################################################### -->
|
||||
|
||||
<!-- These extensions are required for table printing and other stuff -->
|
||||
<xsl:param name="use.extensions">1</xsl:param>
|
||||
<xsl:param name="tablecolumns.extension">0</xsl:param>
|
||||
<xsl:param name="callout.extensions">1</xsl:param>
|
||||
<!-- FOP provide only PDF Bookmarks at the moment -->
|
||||
<xsl:param name="fop.extensions">1</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Table Of Contents
|
||||
################################################### -->
|
||||
|
||||
<!-- Generate the TOCs for named components only -->
|
||||
<xsl:param name="generate.toc">
|
||||
book toc
|
||||
</xsl:param>
|
||||
|
||||
<!-- Show only Sections up to level 3 in the TOCs -->
|
||||
<xsl:param name="toc.section.depth">2</xsl:param>
|
||||
|
||||
<!-- Dot and Whitespace as separator in TOC between Label and Title-->
|
||||
<xsl:param name="autotoc.label.separator" select="'. '"/>
|
||||
|
||||
|
||||
<!--###################################################
|
||||
Paper & Page Size
|
||||
################################################### -->
|
||||
|
||||
<!-- Paper type, no headers on blank pages, no double sided printing -->
|
||||
<xsl:param name="paper.type" select="'A4'"/>
|
||||
<xsl:param name="double.sided">0</xsl:param>
|
||||
<xsl:param name="headers.on.blank.pages">0</xsl:param>
|
||||
<xsl:param name="footers.on.blank.pages">0</xsl:param>
|
||||
|
||||
<!-- Space between paper border and content (chaotic stuff, don't touch) -->
|
||||
<xsl:param name="page.margin.top">5mm</xsl:param>
|
||||
<xsl:param name="region.before.extent">10mm</xsl:param>
|
||||
<xsl:param name="body.margin.top">10mm</xsl:param>
|
||||
|
||||
<xsl:param name="body.margin.bottom">15mm</xsl:param>
|
||||
<xsl:param name="region.after.extent">10mm</xsl:param>
|
||||
<xsl:param name="page.margin.bottom">0mm</xsl:param>
|
||||
|
||||
<xsl:param name="page.margin.outer">18mm</xsl:param>
|
||||
<xsl:param name="page.margin.inner">18mm</xsl:param>
|
||||
|
||||
<!-- No intendation of Titles -->
|
||||
<xsl:param name="title.margin.left">0pc</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Fonts & Styles
|
||||
################################################### -->
|
||||
|
||||
<!-- Left aligned text and no hyphenation -->
|
||||
<xsl:param name="alignment">left</xsl:param>
|
||||
<xsl:param name="hyphenate">false</xsl:param>
|
||||
|
||||
<!-- Default Font size -->
|
||||
<xsl:param name="body.font.master">11</xsl:param>
|
||||
<xsl:param name="body.font.small">8</xsl:param>
|
||||
|
||||
<!-- Line height in body text -->
|
||||
<xsl:param name="line-height">1.4</xsl:param>
|
||||
|
||||
<!-- Monospaced fonts are smaller than regular text -->
|
||||
<xsl:attribute-set name="monospace.properties">
|
||||
<xsl:attribute name="font-family">
|
||||
<xsl:value-of select="$monospace.font.family"/>
|
||||
</xsl:attribute>
|
||||
<xsl:attribute name="font-size">0.8em</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<!--###################################################
|
||||
Tables
|
||||
################################################### -->
|
||||
|
||||
<!-- The table width should be adapted to the paper size -->
|
||||
<xsl:param name="default.table.width">17.4cm</xsl:param>
|
||||
|
||||
<!-- Some padding inside tables -->
|
||||
<xsl:attribute-set name="table.cell.padding">
|
||||
<xsl:attribute name="padding-left">4pt</xsl:attribute>
|
||||
<xsl:attribute name="padding-right">4pt</xsl:attribute>
|
||||
<xsl:attribute name="padding-top">4pt</xsl:attribute>
|
||||
<xsl:attribute name="padding-bottom">4pt</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<!-- Only hairlines as frame and cell borders in tables -->
|
||||
<xsl:param name="table.frame.border.thickness">0.1pt</xsl:param>
|
||||
<xsl:param name="table.cell.border.thickness">0.1pt</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Labels
|
||||
################################################### -->
|
||||
|
||||
<!-- Label Chapters and Sections (numbering) -->
|
||||
<xsl:param name="chapter.autolabel">1</xsl:param>
|
||||
<xsl:param name="section.autolabel" select="1"/>
|
||||
<xsl:param name="section.label.includes.component.label" select="1"/>
|
||||
|
||||
<!--###################################################
|
||||
Titles
|
||||
################################################### -->
|
||||
|
||||
<!-- Chapter title size -->
|
||||
<xsl:attribute-set name="chapter.titlepage.recto.style">
|
||||
<xsl:attribute name="text-align">left</xsl:attribute>
|
||||
<xsl:attribute name="font-weight">bold</xsl:attribute>
|
||||
<xsl:attribute name="font-size">
|
||||
<xsl:value-of select="$body.font.master * 1.8"/>
|
||||
<xsl:text>pt</xsl:text>
|
||||
</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<!-- Why is the font-size for chapters hardcoded in the XSL FO templates?
|
||||
Let's remove it, so this sucker can use our attribute-set only... -->
|
||||
<xsl:template match="title" mode="chapter.titlepage.recto.auto.mode">
|
||||
<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format"
|
||||
xsl:use-attribute-sets="chapter.titlepage.recto.style">
|
||||
<xsl:call-template name="component.title">
|
||||
<xsl:with-param name="node" select="ancestor-or-self::chapter[1]"/>
|
||||
</xsl:call-template>
|
||||
</fo:block>
|
||||
</xsl:template>
|
||||
|
||||
<!-- Sections 1, 2 and 3 titles have a small bump factor and padding -->
|
||||
<xsl:attribute-set name="section.title.level1.properties">
|
||||
<xsl:attribute name="space-before.optimum">0.8em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.maximum">0.8em</xsl:attribute>
|
||||
<xsl:attribute name="font-size">
|
||||
<xsl:value-of select="$body.font.master * 1.5"/>
|
||||
<xsl:text>pt</xsl:text>
|
||||
</xsl:attribute>
|
||||
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
<xsl:attribute-set name="section.title.level2.properties">
|
||||
<xsl:attribute name="space-before.optimum">0.6em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.minimum">0.6em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.maximum">0.6em</xsl:attribute>
|
||||
<xsl:attribute name="font-size">
|
||||
<xsl:value-of select="$body.font.master * 1.25"/>
|
||||
<xsl:text>pt</xsl:text>
|
||||
</xsl:attribute>
|
||||
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
<xsl:attribute-set name="section.title.level3.properties">
|
||||
<xsl:attribute name="space-before.optimum">0.4em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.minimum">0.4em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.maximum">0.4em</xsl:attribute>
|
||||
<xsl:attribute name="font-size">
|
||||
<xsl:value-of select="$body.font.master * 1.0"/>
|
||||
<xsl:text>pt</xsl:text>
|
||||
</xsl:attribute>
|
||||
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<!-- Titles of formal objects (tables, examples, ...) -->
|
||||
<xsl:attribute-set name="formal.title.properties" use-attribute-sets="normal.para.spacing">
|
||||
<xsl:attribute name="font-weight">bold</xsl:attribute>
|
||||
<xsl:attribute name="font-size">
|
||||
<xsl:value-of select="$body.font.master"/>
|
||||
<xsl:text>pt</xsl:text>
|
||||
</xsl:attribute>
|
||||
<xsl:attribute name="hyphenate">false</xsl:attribute>
|
||||
<xsl:attribute name="space-after.minimum">0.4em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.optimum">0.6em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.maximum">0.8em</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<!--###################################################
|
||||
Programlistings
|
||||
################################################### -->
|
||||
|
||||
<!-- Verbatim text formatting (programlistings) -->
|
||||
<xsl:attribute-set name="monospace.verbatim.properties">
|
||||
<xsl:attribute name="font-size">
|
||||
<xsl:value-of select="$body.font.small * 1.0"/>
|
||||
<xsl:text>pt</xsl:text>
|
||||
</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<xsl:attribute-set name="verbatim.properties">
|
||||
<xsl:attribute name="space-before.minimum">1em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.optimum">1em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.maximum">1em</xsl:attribute>
|
||||
<!-- alef: commented out because footnotes were screwed because of it -->
|
||||
<!--<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>-->
|
||||
<xsl:attribute name="border-color">#444444</xsl:attribute>
|
||||
<xsl:attribute name="border-style">solid</xsl:attribute>
|
||||
<xsl:attribute name="border-width">0.1pt</xsl:attribute>
|
||||
<xsl:attribute name="padding-top">0.5em</xsl:attribute>
|
||||
<xsl:attribute name="padding-left">0.5em</xsl:attribute>
|
||||
<xsl:attribute name="padding-right">0.5em</xsl:attribute>
|
||||
<xsl:attribute name="padding-bottom">0.5em</xsl:attribute>
|
||||
<xsl:attribute name="margin-left">0.5em</xsl:attribute>
|
||||
<xsl:attribute name="margin-right">0.5em</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<!-- Shade (background) programlistings -->
|
||||
<xsl:param name="shade.verbatim">1</xsl:param>
|
||||
<xsl:attribute-set name="shade.verbatim.style">
|
||||
<xsl:attribute name="background-color">#F0F0F0</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<!--###################################################
|
||||
Callouts
|
||||
################################################### -->
|
||||
|
||||
<!-- Use images for callouts instead of (1) (2) (3) -->
|
||||
<xsl:param name="callout.graphics">0</xsl:param>
|
||||
<xsl:param name="callout.unicode">1</xsl:param>
|
||||
|
||||
<!-- Place callout marks at this column in annotated areas -->
|
||||
<xsl:param name="callout.defaultcolumn">90</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Admonitions
|
||||
################################################### -->
|
||||
|
||||
<!-- Use nice graphics for admonitions -->
|
||||
<xsl:param name="admon.graphics">'1'</xsl:param>
|
||||
<xsl:param name="admon.graphics.path">&admon_gfx_path;</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Misc
|
||||
################################################### -->
|
||||
|
||||
<!-- Placement of titles -->
|
||||
<xsl:param name="formal.title.placement">
|
||||
figure after
|
||||
example before
|
||||
equation before
|
||||
table before
|
||||
procedure before
|
||||
</xsl:param>
|
||||
|
||||
<!-- Format Variable Lists as Blocks (prevents horizontal overflow) -->
|
||||
<xsl:param name="variablelist.as.blocks">1</xsl:param>
|
||||
|
||||
<!-- The horrible list spacing problems -->
|
||||
<xsl:attribute-set name="list.block.spacing">
|
||||
<xsl:attribute name="space-before.optimum">0.8em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.minimum">0.8em</xsl:attribute>
|
||||
<xsl:attribute name="space-before.maximum">0.8em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.optimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.minimum">0.1em</xsl:attribute>
|
||||
<xsl:attribute name="space-after.maximum">0.1em</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
</xsl:stylesheet>
|
||||
168
doc/docbook/styles/html.css
Normal file
@@ -0,0 +1,168 @@
|
||||
A {
|
||||
color: #003399;
|
||||
}
|
||||
|
||||
A:active {
|
||||
color: #003399;
|
||||
}
|
||||
|
||||
A:visited {
|
||||
color: #888888;
|
||||
}
|
||||
|
||||
P, DL, DT, DD, BLOCKQUOTE {
|
||||
color: #000000;
|
||||
margin-bottom: 3px;
|
||||
margin-top: 3px;
|
||||
padding-top: 0px;
|
||||
/*border: 1px solid black;*/
|
||||
}
|
||||
|
||||
OL, UL, P {
|
||||
margin-top: 6px;
|
||||
margin-bottom: 6px;
|
||||
}
|
||||
|
||||
P, BLOCKQUOTE {
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
P.releaseinfo {
|
||||
font-size: 120%; font-weight: bold;
|
||||
font-family: Arial, helvetica, sans-serif;
|
||||
padding-top: 10px;
|
||||
}
|
||||
|
||||
P.pubdate {
|
||||
font-size: 120%; font-weight: bold;
|
||||
font-family: Arial, helvetica, sans-serif;
|
||||
}
|
||||
|
||||
td {
|
||||
font-size: 80%;
|
||||
}
|
||||
|
||||
|
||||
TD, TH, SPAN {
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
BLOCKQUOTE {
|
||||
margin-right: 0px;
|
||||
}
|
||||
|
||||
H1, H2, H3, H4, H5, H6 {
|
||||
color: #000000;
|
||||
font-weight:500;
|
||||
margin-top:0px;
|
||||
padding-top:14px;
|
||||
font-family: Arial, helvetica, sans-serif;
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
H2.title {
|
||||
font-weight:800;
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
|
||||
H2.subtitle {
|
||||
font-weight:800;
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
H3.author {
|
||||
color: #000000;
|
||||
font-weight:500;
|
||||
margin-top:0px;
|
||||
padding-top:0px;
|
||||
font-family: Arial, helvetica, sans-serif;
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
TABLE {
|
||||
border-collapse: collapse;
|
||||
border-spacing:0;
|
||||
border: 1px thin black;
|
||||
empty-cells: hide;
|
||||
}
|
||||
|
||||
TD {
|
||||
padding: 4pt;
|
||||
}
|
||||
|
||||
H1 {
|
||||
font-size: 150%;
|
||||
}
|
||||
H2 {
|
||||
font-size: 110%;
|
||||
}
|
||||
H3 {
|
||||
font-size: 100%; font-weight: bold;
|
||||
}
|
||||
H4 {
|
||||
font-size: 90%; font-weight: bold;
|
||||
}
|
||||
H5 {
|
||||
font-size: 90%; font-style: italic;
|
||||
}
|
||||
H6 {
|
||||
font-size: 100%; font-style: italic;
|
||||
}
|
||||
|
||||
TT {
|
||||
font-size: 90%;
|
||||
font-family: "Courier New", Courier, monospace;
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
.navheader, .navfooter {
|
||||
background-color: #e4eff3;
|
||||
}
|
||||
|
||||
PRE {
|
||||
font-size: 90%;
|
||||
padding: 5px;
|
||||
border-style: solid;
|
||||
border-width: 1px;
|
||||
border-color: #CCCCCC;
|
||||
background-color: #F4F4F4;
|
||||
}
|
||||
|
||||
UL, OL, LI {
|
||||
list-style: disc;
|
||||
}
|
||||
|
||||
HR {
|
||||
width: 100%;
|
||||
height: 1px;
|
||||
background-color: #CCCCCC;
|
||||
border-width: 0px;
|
||||
padding: 0px;
|
||||
color: #CCCCCC;
|
||||
}
|
||||
|
||||
.variablelist {
|
||||
padding-top: 10;
|
||||
padding-bottom:10;
|
||||
margin:0;
|
||||
}
|
||||
|
||||
/*(.itemizedlist, UL {
|
||||
padding-top: 0;
|
||||
padding-bottom:0;
|
||||
margin:0;
|
||||
}*/
|
||||
|
||||
.term {
|
||||
font-weight:bold;
|
||||
}
|
||||
|
||||
.mediaobject {
|
||||
padding-top: 30px;
|
||||
padding-bottom: 30px;
|
||||
}
|
||||
|
||||
.legalnotice {
|
||||
font-size: 70%;
|
||||
}
|
||||
|
||||
94
doc/docbook/styles/html/docbook.xsl
Normal file
@@ -0,0 +1,94 @@
|
||||
<?xml version="1.0"?>
|
||||
|
||||
<!--
|
||||
|
||||
This is the XSL HTML configuration file for the Hibernate
|
||||
Reference Documentation.
|
||||
|
||||
It took me days to figure out this stuff and fix most of
|
||||
the obvious bugs in the DocBook XSL distribution, so if you
|
||||
use this stylesheet, give some credit back to the Hibernate
|
||||
project.
|
||||
|
||||
christian.bauer@bluemars.de
|
||||
-->
|
||||
|
||||
<!DOCTYPE xsl:stylesheet [
|
||||
<!ENTITY db_xsl_bak "docbook-bak.xsl">
|
||||
<!ENTITY callout_gfx_path "../images/callouts/">
|
||||
<!ENTITY admon_gfx_path "../images/admons/">
|
||||
]>
|
||||
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||
version="1.0"
|
||||
xmlns="http://www.w3.org/TR/xhtml1/transitional"
|
||||
exclude-result-prefixes="#default">
|
||||
|
||||
<xsl:import href="&db_xsl_bak;"/>
|
||||
|
||||
<!--###################################################
|
||||
HTML Settings
|
||||
################################################### -->
|
||||
|
||||
<xsl:param name="html.stylesheet">../styles/html.css</xsl:param>
|
||||
|
||||
<!-- These extensions are required for table printing and other stuff -->
|
||||
<xsl:param name="use.extensions">1</xsl:param>
|
||||
<xsl:param name="tablecolumns.extension">0</xsl:param>
|
||||
<xsl:param name="callout.extensions">1</xsl:param>
|
||||
<xsl:param name="graphicsize.extension">0</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Table Of Contents
|
||||
################################################### -->
|
||||
|
||||
<!-- Generate the TOCs for named components only -->
|
||||
<xsl:param name="generate.toc">
|
||||
book toc
|
||||
</xsl:param>
|
||||
|
||||
<!-- Show only Sections up to level 3 in the TOCs -->
|
||||
<xsl:param name="toc.section.depth">3</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Labels
|
||||
################################################### -->
|
||||
|
||||
<!-- Label Chapters and Sections (numbering) -->
|
||||
<xsl:param name="chapter.autolabel">1</xsl:param>
|
||||
<xsl:param name="section.autolabel" select="1"/>
|
||||
<xsl:param name="section.label.includes.component.label" select="1"/>
|
||||
|
||||
<!--###################################################
|
||||
Callouts
|
||||
################################################### -->
|
||||
|
||||
<!-- Use images for callouts instead of (1) (2) (3) -->
|
||||
<xsl:param name="callout.graphics">1</xsl:param>
|
||||
<xsl:param name="callout.graphics.path">&callout_gfx_path;</xsl:param>
|
||||
|
||||
<!-- Place callout marks at this column in annotated areas -->
|
||||
<xsl:param name="callout.defaultcolumn">90</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Admonitions
|
||||
################################################### -->
|
||||
|
||||
<!-- Use nice graphics for admonitions -->
|
||||
<xsl:param name="admon.graphics">'1'</xsl:param>
|
||||
<xsl:param name="admon.graphics.path">&admon_gfx_path;</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Misc
|
||||
################################################### -->
|
||||
|
||||
<!-- Placement of titles -->
|
||||
<xsl:param name="formal.title.placement">
|
||||
figure after
|
||||
example before
|
||||
equation before
|
||||
table before
|
||||
procedure before
|
||||
</xsl:param>
|
||||
|
||||
</xsl:stylesheet>
|
||||
96
doc/docbook/styles/html_chunk.xsl
Normal file
@@ -0,0 +1,96 @@
|
||||
<?xml version="1.0"?>
|
||||
|
||||
<!--
|
||||
|
||||
This is the XSL HTML configuration file for the Hibernate
|
||||
Reference Documentation.
|
||||
|
||||
It took me days to figure out this stuff and fix most of
|
||||
the obvious bugs in the DocBook XSL distribution, so if you
|
||||
use this stylesheet, give some credit back to the Hibernate
|
||||
project.
|
||||
|
||||
christian.bauer@bluemars.de
|
||||
-->
|
||||
|
||||
<!DOCTYPE xsl:stylesheet [
|
||||
<!ENTITY db_xsl_path "../lib/docbook-xsl/">
|
||||
<!ENTITY callout_gfx_path "../images/callouts/">
|
||||
<!ENTITY admon_gfx_path "../images/admons/">
|
||||
]>
|
||||
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||
version="1.0"
|
||||
xmlns="http://www.w3.org/TR/xhtml1/transitional"
|
||||
exclude-result-prefixes="#default">
|
||||
|
||||
<xsl:import href="&db_xsl_path;/html/chunk.xsl"/>
|
||||
|
||||
<!--###################################################
|
||||
HTML Settings
|
||||
################################################### -->
|
||||
|
||||
<xsl:param name="chunk.section.depth">'5'</xsl:param>
|
||||
<xsl:param name="use.id.as.filename">'1'</xsl:param>
|
||||
<xsl:param name="html.stylesheet">../styles/html.css</xsl:param>
|
||||
|
||||
<!-- These extensions are required for table printing and other stuff -->
|
||||
<xsl:param name="use.extensions">1</xsl:param>
|
||||
<xsl:param name="tablecolumns.extension">0</xsl:param>
|
||||
<xsl:param name="callout.extensions">1</xsl:param>
|
||||
<xsl:param name="graphicsize.extension">0</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Table Of Contents
|
||||
################################################### -->
|
||||
|
||||
<!-- Generate the TOCs for named components only -->
|
||||
<xsl:param name="generate.toc">
|
||||
book toc
|
||||
</xsl:param>
|
||||
|
||||
<!-- Show only Sections up to level 3 in the TOCs -->
|
||||
<xsl:param name="toc.section.depth">3</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Labels
|
||||
################################################### -->
|
||||
|
||||
<!-- Label Chapters and Sections (numbering) -->
|
||||
<xsl:param name="chapter.autolabel">1</xsl:param>
|
||||
<xsl:param name="section.autolabel" select="1"/>
|
||||
<xsl:param name="section.label.includes.component.label" select="1"/>
|
||||
|
||||
<!--###################################################
|
||||
Callouts
|
||||
################################################### -->
|
||||
|
||||
<!-- Use images for callouts instead of (1) (2) (3) -->
|
||||
<xsl:param name="callout.graphics">1</xsl:param>
|
||||
<xsl:param name="callout.graphics.path">&callout_gfx_path;</xsl:param>
|
||||
|
||||
<!-- Place callout marks at this column in annotated areas -->
|
||||
<xsl:param name="callout.defaultcolumn">90</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Admonitions
|
||||
################################################### -->
|
||||
|
||||
<!-- Use nice graphics for admonitions -->
|
||||
<xsl:param name="admon.graphics">'1'</xsl:param>
|
||||
<xsl:param name="admon.graphics.path">&admon_gfx_path;</xsl:param>
|
||||
|
||||
<!--###################################################
|
||||
Misc
|
||||
################################################### -->
|
||||
|
||||
<!-- Placement of titles -->
|
||||
<xsl:param name="formal.title.placement">
|
||||
figure after
|
||||
example before
|
||||
equation before
|
||||
table before
|
||||
procedure before
|
||||
</xsl:param>
|
||||
|
||||
</xsl:stylesheet>
|
||||
38
doc/maven.xml
Normal file
@@ -0,0 +1,38 @@
|
||||
<project
|
||||
xmlns:j="jelly:core"
|
||||
xmlns:ant="jelly:ant"
|
||||
xmlns:util="jelly:util"
|
||||
xmlns:maven="jelly:maven"
|
||||
>
|
||||
|
||||
<postGoal name="sdocbook:prepare-filesystem">
|
||||
<j:set var="unzipped" value="false" />
|
||||
<util:available file="${maven.sdocbook.generated.fo}">
|
||||
<j:set var="unzipped" value="true" />
|
||||
<echo>Using previusly unzipped docbook files</echo>
|
||||
</util:available>
|
||||
<j:if test="${!unzipped}">
|
||||
<!-- unzip docbook files -->
|
||||
<ant:unzip dest="${maven.build.dir}"
|
||||
src="${pom.getDependencyPath('docbook:docbook-xsl')}"/>
|
||||
|
||||
<!-- use a custom fo stylesheet -->
|
||||
<move file="${maven.sdocbook.stylesheets.dir}/fo/docbook.xsl"
|
||||
tofile="${maven.sdocbook.stylesheets.dir}/fo/docbook-bak.xsl"/>
|
||||
<copy file="${maven.sdocbook.src.dir}/styles/fo/docbook.xsl"
|
||||
todir="${maven.sdocbook.stylesheets.dir}/fo"/>
|
||||
|
||||
<!-- use a custom html stylesheet -->
|
||||
<move file="${maven.sdocbook.stylesheets.dir}/html/docbook.xsl"
|
||||
tofile="${maven.sdocbook.stylesheets.dir}/html/docbook-bak.xsl"/>
|
||||
<copy file="${maven.sdocbook.src.dir}/styles/html/docbook.xsl"
|
||||
todir="${maven.sdocbook.stylesheets.dir}/html"/>
|
||||
|
||||
<copy todir="${maven.sdocbook.stylesheets.dir}">
|
||||
<fileset dir="${maven.sdocbook.src.dir}/images"/>
|
||||
</copy>
|
||||
</j:if>
|
||||
|
||||
</postGoal>
|
||||
|
||||
</project>
|
||||
5
doc/project.properties
Normal file
@@ -0,0 +1,5 @@
|
||||
# sdocbook
|
||||
maven.sdocbook.fo.params=-PARAM paper.type A4 -PARAM use.extensions 1 -PARAM tablecolumns.extension 0 -PARAM callout.extensions 1 -PARAM fop.extensions=1
|
||||
maven.sdocbook.src.dir=${basedir}/docbook
|
||||
maven.sdocbook.resources.include=**/*.gif,**/*.svg,**/*.jpg
|
||||
maven.sdocbook.stylesheets.dir=${maven.build.dir}/docbook-xsl-1.66.1
|
||||
25
doc/project.xml
Normal file
@@ -0,0 +1,25 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project>
|
||||
<extend>${basedir}/../project.xml</extend>
|
||||
<artifactId>acegi-security-doc</artifactId>
|
||||
<name>Acegi Security System for Spring - Documentation</name>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>maven-plugins</groupId>
|
||||
<artifactId>maven-sdocbook-plugin</artifactId>
|
||||
<version>1.4-SNAPSHOT</version>
|
||||
<type>plugin</type>
|
||||
</dependency>
|
||||
|
||||
<!-- docbook -->
|
||||
<dependency>
|
||||
<groupId>docbook</groupId>
|
||||
<artifactId>docbook-xsl</artifactId>
|
||||
<version>1.66.1</version>
|
||||
<url>http://docbook.sourceforge.net</url>
|
||||
<type>zip</type>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
</project>
|
||||
|
||||
49
doc/xdocs/faq.xml
Normal file
@@ -0,0 +1,49 @@
|
||||
<?xml version="1.0"?>
|
||||
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Acegi FAQ</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
|
||||
<section name="Frequently Asked Questions">
|
||||
<p>
|
||||
This document attempts to answer some of the more frequently asked
|
||||
questions regarding various aspects of JBoss. These questions are
|
||||
typically asked over and over again on the mailing lists and forums. As a
|
||||
courtesy to the developers, we ask that you read this document
|
||||
before posting to the mailing lists.
|
||||
</p>
|
||||
<p>
|
||||
<strong>General</strong>
|
||||
</p>
|
||||
<ol>
|
||||
<li>
|
||||
<a href="#what-is-acegi">
|
||||
What is Acegi?
|
||||
</a>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<p>
|
||||
<strong>More FAQs ...</strong>
|
||||
</p>
|
||||
|
||||
|
||||
<section name="General">
|
||||
<dl>
|
||||
<dt>
|
||||
<a name="what-is-acegi">
|
||||
What is Acegi?
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
...
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
191
doc/xdocs/index.html
Normal file
@@ -0,0 +1,191 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<HTML><HEAD><TITLE>Acegi Security System for Spring</TITLE>
|
||||
<META http-equiv=Content-Type content="text/html; charset=windows-1252">
|
||||
<META content="MSHTML 6.00.2900.2180" name=GENERATOR></HEAD>
|
||||
<BODY>
|
||||
<p>
|
||||
This is the Maven generated site for the Acegi-Security project. It is generated as part of an
|
||||
automated daily build. We intend to expand the information on Acegi which is available here but for
|
||||
the moment, your best starting point for documentation is Ben Alex's
|
||||
original <a href="./reference/index.html">reference guide</a>
|
||||
which provides a comprehensive overview.
|
||||
</p>
|
||||
<p>
|
||||
For more information on running the build with Maven, see the
|
||||
<a href="./start/build.html">build</a> section of the getting started guide.
|
||||
</p>
|
||||
<p>
|
||||
The main other area of interest at the moment is the <a href="./maven-reports.html">generated reports</a> section.
|
||||
These are produced by the build on a daily basis and include complete Javadoc and source cross-reference.
|
||||
</p>
|
||||
|
||||
<CENTER>
|
||||
</CENTER><BR><BR><FONT
|
||||
face=Arial size=-1>
|
||||
<CENTER><B>
|
||||
<HR>
|
||||
|
||||
<CENTER>Mission Statement</CENTER></B>
|
||||
<HR>
|
||||
<BR>To provide comprehensive security services for <A
|
||||
href="http://www.springframework.org/"><I>The Spring Framework</I></A>.
|
||||
</CENTER><BR><B>
|
||||
<HR>
|
||||
|
||||
<CENTER>Key Features</CENTER></B>
|
||||
<HR>
|
||||
<BR>
|
||||
<UL>
|
||||
<LI><B>It is ready NOW.</B> As explained in the reference guide, the API
|
||||
is now quite stable. We also use the <A
|
||||
href="http://apr.apache.org/versioning.html">Apache APR Project
|
||||
Versioning Guidelines</A> so you can identify backward
|
||||
compatibility.<BR><BR>
|
||||
<LI><B>Easy to use:</B> View our samples/quick-start directory for XML
|
||||
you can simply copy and paste into applicationContext.xml and web.xml.
|
||||
From there it's easy to customise Acegi Security to your unique security
|
||||
needs.<BR><BR>
|
||||
<LI><B>Enterprise-wide single sign on:</B> Using Yale University's open
|
||||
source <A href="http://www.yale.edu/tp/auth/">Central Authentication
|
||||
Service</A> (CAS), the Acegi Security System for Spring can participate
|
||||
in an enterprise-wide single sign on environment. You no longer need
|
||||
every web application to have its own authentication database. Nor are
|
||||
you restricted to single sign on across a single web container. Advanced
|
||||
single sign on features like proxy support and forced refresh of logins
|
||||
are supported by both CAS and Acegi Security.<BR><BR>
|
||||
<LI><B>Reuses your Spring expertise:</B> We use Spring application
|
||||
contexts for all configuration, which should help Spring developers get
|
||||
up-to-speed nice and quickly.<BR><BR>
|
||||
<LI><B>Domain object instance security:</B> In many applications it's
|
||||
desirable to define Access Control Lists (ACLs) for individual domain
|
||||
object instances. We provide a comprehensive ACL package with features
|
||||
including integer bit masking, permission inheritence (including
|
||||
blocking), a JDBC-backed ACL repository, caching and a pluggable,
|
||||
interface-driven design.<BR><BR>
|
||||
<LI><B>Non-intrusive setup:</B> The entire security system can operate
|
||||
within a single web application using the provided filters. There is no
|
||||
need to make special changes or deploy libraries to your Servlet or EJB
|
||||
container.<BR><BR>
|
||||
<LI><B>Full (but optional) container integration:</B> The credential
|
||||
collection and authorization capabilities of your Servlet or EJB
|
||||
container can be fully utilised via included "container adapters". We
|
||||
currently support Catalina (Tomcat), Jetty, JBoss and Resin, with
|
||||
additional containers easily added.<BR><BR>
|
||||
<LI><B>Keeps your objects free of security code:</B> Many applications
|
||||
need to secure data at the bean level based on any combination of
|
||||
parameters (user, time of day, authorities held, method being invoked,
|
||||
parameter on method being invoked....). This package gives you this
|
||||
flexibility without adding security code to your Spring business
|
||||
objects.<BR><BR>
|
||||
<LI><B>Secures your HTTP requests as well:</B> In addition to securing
|
||||
your beans, the project also secures your HTTP requests. No longer is it
|
||||
necessary to rely on web.xml security constraints. Best of all, your
|
||||
HTTP requests can now be secured by your choice of regular expressions
|
||||
or Apache Ant paths, along with pluggable authentication, authorization
|
||||
and run-as replacement managers.<BR><BR>
|
||||
<LI><B>Channel security:</B> The Acegi Security System for Spring can
|
||||
automatically redirect requests across an appropriate transport channel.
|
||||
Whilst flexible enough to support any of your "channel" requirements (eg
|
||||
the remote user is a human, not a robot), a common channel security
|
||||
feature is to ensure your secure pages will only be available over
|
||||
HTTPS, and your public pages only over HTTP. Acegi Security also
|
||||
supports unusual port combinations and pluggable transport decision
|
||||
managers.<BR><BR>
|
||||
<LI><B>Supports HTTP BASIC authentication:</B> Perfect for remoting
|
||||
protocols or those web applications that prefer a simple browser pop-up
|
||||
(rather than a form login), Acegi Security can directly process HTTP
|
||||
BASIC authentication requests as per RFC 1945.<BR><BR>
|
||||
<LI><B>Convenient security taglib:</B> Your JSP files can use our taglib
|
||||
to ensure that protected content like links and messages are only
|
||||
displayed to users holding the appropriate granted authorities.<BR><BR>
|
||||
<LI><B>Application context or attribute-based configuration:</B> You
|
||||
select the method used to configure your security environment. The
|
||||
project supports configuration via Spring application contexts as well
|
||||
as Jakarta Commons Attributes.<BR><BR>
|
||||
<LI><B>Various authentication backends:</B> We include the ability to
|
||||
retrieve your user and granted authority definitions from either an XML
|
||||
file or JDBC datasource. Alternatively, you can implement the
|
||||
single-method DAO interface and obtain authentication details from
|
||||
anywhere you like.<BR><BR>
|
||||
<LI><B>Event support:</B> Building upon Spring's
|
||||
<CODE>ApplicationEvent</CODE> services, you can write your own listeners
|
||||
for login, invalid password and account disabled events. This enables
|
||||
you to implement account lockout and audit log systems, with complete
|
||||
decoupling from Acegi Security code.<BR><BR>
|
||||
<LI><B>Easy integration with existing databases:</B> Our implementations
|
||||
have been designed to make it very easy to use your existing
|
||||
authentication schema and data (without modification).<BR><BR>
|
||||
<LI><B>Caching:</B> Use our <A
|
||||
href="http://ehcache.sourceforge.net/">EHCACHE</A> wrapper to cache your
|
||||
authentication information, or plug in your own cache implementation.
|
||||
This flexibility means your database (or other authentication
|
||||
repository) is not repeatedly queried for authentication
|
||||
information.<BR><BR>
|
||||
<LI><B>Pluggable architecture:</B> Every critical aspect of the package
|
||||
has been modelled using high cohesion, loose coupling, interface-driven
|
||||
design principles. You can easily replace, customise or extend parts of
|
||||
the package.<BR><BR>
|
||||
<LI><B>Startup-time validation:</B> Every critical object dependency and
|
||||
configuration parameter is validated at application context startup
|
||||
time. Security configuration errors are therefore detected early and
|
||||
corrected quickly.<BR><BR>
|
||||
<LI><B>Remoting support:</B> Does your project use a rich client? Not a
|
||||
problem. Acegi Security integrates with standard Spring remoting
|
||||
protocols, because it automatically processes the HTTP BASIC
|
||||
authentication headers they present. Add our BASIC authentication filter
|
||||
to your web.xml and you're done.<BR><BR>
|
||||
<LI><B>Advanced password encoding:</B> Of course, passwords in your
|
||||
authentication repository need not be in plain text. We support both SHA
|
||||
and MD5 encoding, and also pluggable "salt" providers to maximise
|
||||
password security.<BR><BR>
|
||||
<LI><B>Run-as replacement:</B> The security system fully supports
|
||||
temporarily replacing the authenticated user for the duration of the web
|
||||
request or bean invocation. This enables you to build public-facing
|
||||
object tiers with different security configurations than your backend
|
||||
objects.<BR><BR>
|
||||
<LI><B>Unit tests:</B> A must-have of any quality security project, unit
|
||||
tests are included. Clover coverage is currently 98.3%.<BR><BR>
|
||||
<LI><B>Container integration tests:</B> To ensure the security project
|
||||
properly operates with major container versions, we provide an
|
||||
integration test system that deploys those containers from scratch and
|
||||
fully tests our sample web application from the perspective of a HTTP
|
||||
client.<BR><BR>
|
||||
<LI><B>Supports your own unit tests:</B> We provide a number of classes
|
||||
that assist with your own unit testing of secured business objects. For
|
||||
example, you can change the authentication identity and its associated
|
||||
granted authorities directly within your test methods.<BR><BR>
|
||||
<LI><B>Peer reviewed:</B> Whilst nothing is ever completely secure,
|
||||
using an open source security package leverages the continuous design
|
||||
and code quality improvements that emerge from peer review.<BR><BR>
|
||||
<LI><B>Thorough documentation:</B> All APIs are fully documented using
|
||||
JavaDoc, with a 40+ page reference guide providing an easy-to-follow
|
||||
introduction.<BR><BR>
|
||||
<LI><B>Apache license.</B><BR><BR></LI></UL><BR><B>
|
||||
<HR>
|
||||
|
||||
<CENTER>Project Resources</CENTER></B>
|
||||
<HR>
|
||||
<BR>
|
||||
<CENTER><A href="http://forum.springframework.org/"><B>Support
|
||||
Forums</B></A><BR><BR><A
|
||||
href="http://sourceforge.net/project/showfiles.php?group_id=104215"><B>Downloads</B></A><BR><BR><A
|
||||
href="http://www.monkeymachine.co.uk/acegi">Public Maven Build (Javadocs,
|
||||
Source Code etc)</A><BR><BR><A
|
||||
href="http://cvs.sourceforge.net/viewcvs.py/acegisecurity">Browse
|
||||
CVS</A><BR><BR><BR><B>
|
||||
<HR>
|
||||
|
||||
<CENTER>Development Mailing List</CENTER></B>
|
||||
<HR>
|
||||
<BR><A
|
||||
href="https://lists.sourceforge.net/lists/listinfo/acegisecurity-developer">Subscribe
|
||||
Here</A><BR><BR><A
|
||||
href="http://news.gmane.org/gmane.comp.java.springframework.acegisecurity.devel/">Gmane
|
||||
Archive</A><BR><BR><A
|
||||
href="http://www.mail-archive.com/acegisecurity-developer@lists.sourceforge.net/">Mail-archive.com
|
||||
Archive</A><BR><BR><BR><A
|
||||
href="http://sourceforge.net/projects/acegisecurity"><IMG height=31
|
||||
alt="SourceForge.net Logo"
|
||||
src="Acegi Security System for Spring_archivos/sflogo.png" width=88
|
||||
border=0></A> </CENTER></FONT>
|
||||
</BODY></HTML>
|
||||
28
doc/xdocs/navigation.xml
Normal file
@@ -0,0 +1,28 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<project name="Maven">
|
||||
|
||||
<title>Acegi Security System for Spring</title>
|
||||
<body>
|
||||
<menu name="Overview">
|
||||
<!-- <item name="Goals" href="/goals.html"/>
|
||||
<item name="Features" href="/features.html"/> -->
|
||||
<item name="News and Status" href="/status.html"/>
|
||||
<item name="Getting Started" href="/start/index.html" collapse="true">
|
||||
<item name="Download" href="/start/download.html"/>
|
||||
<item name="Build" href="/start/build.html"/>
|
||||
</item>
|
||||
<item name="Reference" href="/reference/index.html" collapse="true">
|
||||
<item name="User Guide" href="/ref/index.html"/>
|
||||
<!-- item name="Developer Guide" href="/reference/developer-guide.html"/ -->
|
||||
<!-- item name="FAQ" href="/faq.html"/ -->
|
||||
</item>
|
||||
</menu>
|
||||
<!--
|
||||
<menu name="Misc">
|
||||
<item name="Wiki" href=""/>
|
||||
<item name="Glossary" href="/glossary.html"/>
|
||||
<item name="Articles" href="/articles.html"/>
|
||||
</menu>
|
||||
-->
|
||||
</body>
|
||||
</project>
|
||||
33
doc/xdocs/reference/index.xml
Normal file
@@ -0,0 +1,33 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Reference Documentation</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Reference Documentation">
|
||||
|
||||
<subsection name="Overview of the Reference Documentation">
|
||||
<table>
|
||||
<tr><th>Document</th><th>Description</th></tr>
|
||||
|
||||
<tr><td><a href="../ref/index.html">Reference Guide</a></td>
|
||||
<td>
|
||||
The original docbook-generated reference. This is a good place to start if you want
|
||||
to use the Acegi System to secure your applications.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<!-- <tr><td><a href="developer-guide.html">Developer Guide</a></td>
|
||||
<td>
|
||||
The Developer Guide is intended to help developers get
|
||||
acquainted with the project.
|
||||
</td>
|
||||
</tr>
|
||||
-->
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
38
doc/xdocs/start/build.xml
Normal file
@@ -0,0 +1,38 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Building Acegi</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Building Acegi">
|
||||
<p>
|
||||
TODO: Checkout the source from Sourceforge...
|
||||
</p>
|
||||
|
||||
<subsection name="Maven Build">
|
||||
<p>
|
||||
The first thing to do if you want to use Maven is download and install it.
|
||||
The build has been tested with version 1-rc3 so use this or a later version if possible.
|
||||
</p>
|
||||
<p>
|
||||
One of the main differences between Maven and plain ant is that Maven manages
|
||||
external dependencies for your projects and (at least in theory) you should no
|
||||
longer have to store third-party jar files in your CVS tree. It maintains a local repository of
|
||||
versioned libraries and shares them between your Maven projects. If it can't find the necessary
|
||||
files there it will attempt to download them from the main Maven repository at www.ibiblio.org/maven.
|
||||
So to use the Maven build, you need to have a network connection available for the inital download of
|
||||
the project dependencies (and any others that Maven itself requires).
|
||||
</p>
|
||||
<p>
|
||||
Once you have Maven installed, building the project should be as simple as typing "maven jar"
|
||||
from the command line. Providing there are no failures in the test suite, this will create the
|
||||
project jar files in the "target" directory. For more information on using Maven, have a look at the
|
||||
<a href="http://maven.apache.org/">Maven web site</a>.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
18
doc/xdocs/start/download.xml
Normal file
@@ -0,0 +1,18 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Downloading Acegi</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Downloading Acegi">
|
||||
|
||||
<p>
|
||||
You can downloade the latest release from the
|
||||
<a href="http://sourceforge.net/project/showfiles.php?group_id=104215">Sourceforge project site</a>.
|
||||
</p>
|
||||
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
26
doc/xdocs/start/index.xml
Normal file
@@ -0,0 +1,26 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Getting Started with Acegi</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Getting Started with Acegi">
|
||||
|
||||
<subsection name="Overview of the Getting Started Documentation">
|
||||
<table>
|
||||
<tr><th>Document</th><th>Description</th></tr>
|
||||
<tr><td><a href="download.html">Download</a></td>
|
||||
<td>
|
||||
Before you can start using Acegi, you'll have
|
||||
to download the distribution to your system (unless
|
||||
you plan on building the project from source). This document
|
||||
provides links to the various distributions available.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
43
doc/xdocs/status.xml
Normal file
@@ -0,0 +1,43 @@
|
||||
<?xml version="1.0"?>
|
||||
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>News and Status</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="News and Status">
|
||||
|
||||
<subsection name="Current Status">
|
||||
<p>
|
||||
The next release of Acegi will be version 0.6.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
<subsection name="5th June 2004">
|
||||
<p>
|
||||
Version 0.51 released.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
<subsection name="28th April 2004">
|
||||
<p>
|
||||
Version 0.5 released.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
<subsection name="3rd April 2004">
|
||||
<p>
|
||||
Version 0.4 released.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
<subsection name="18th March 2004">
|
||||
<p>
|
||||
Version 0.3 released.
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||