Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor doc updates

This commit is contained in:
Luke Taylor 2009-12-01 16:49:42 +00:00
parent dada789814
commit 910c1163e8
2 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/manual/src/docbook/classindex.pl
View File

@ -28,6 +28,8 @@ $#all_classes > 0 || die "No lines in Javadoc";
my %classnames_to_src; my %classnames_to_src;
print "Extracting classnames to links map from Javadoc...\n";
while ($_ = pop @all_classes) { while ($_ = pop @all_classes) {
chomp; chomp;
# Get rid of the italic tags round interface names # Get rid of the italic tags round interface names
@ -42,6 +44,8 @@ while ($_ = pop @all_classes) {
# The list of docbook files xincluded in the manual # The list of docbook files xincluded in the manual
my @docbook; my @docbook;
print "Building list of docbook source files...\n";
# Read the includes rather than using globbing to get the ordering right for the index. # Read the includes rather than using globbing to get the ordering right for the index.
open MAINDOC, "<springsecurity.xml"; open MAINDOC, "<springsecurity.xml";
while(<MAINDOC>) { while(<MAINDOC>) {
@ -54,6 +58,7 @@ while(<MAINDOC>) {
my %id_to_html; my %id_to_html;
# Build map of html pages links # Build map of html pages links
print "Building map of section xml:ids to reference manual links...\n";
while (my $file = pop @docbook) { while (my $file = pop @docbook) {
open FILE, $file or die "$!"; open FILE, $file or die "$!";
# print "\nProcessing: $file\n\n"; # print "\nProcessing: $file\n\n";
@ -76,11 +81,12 @@ while (my $file = pop @docbook) {
} }
# Get the list of class/interface names and their section ids/titles # Get the list of class/interface names and their section ids/titles
print "Obtaining class and interface references from manual...\n";
my @class_references = split /;/,`xsltproc --xinclude index-classes.xsl springsecurity.xml`; my @class_references = split /;/,`xsltproc --xinclude index-classes.xsl springsecurity.xml`;
# Get unique values # Get unique values
my %seen = (); my %seen = ();
@class_references = grep { !$seen{$_}++} @class_references; @class_references = grep { !$seen{$_}++} @class_references;
print "\nThere are $#class_references references to classes and interfaces.\n"; print "There are $#class_references references to classes and interfaces.\n";
my %id_to_title; my %id_to_title;
my %classnames_to_ids = (); my %classnames_to_ids = ();
@ -92,6 +98,8 @@ foreach my $class_id_title (@class_references) {
$id_to_title{$id} = $title; $id_to_title{$id} = $title;
push( @{$classnames_to_ids{$class}}, $id ); push( @{$classnames_to_ids{$class}}, $id );
} }
print "Writing index file...\n";
open INDEX, ">classindex.xml" || die "Couldn't open output file\n"; open INDEX, ">classindex.xml" || die "Couldn't open output file\n";
print INDEX "<index>\n"; print INDEX "<index>\n";
foreach my $class (sort keys %classnames_to_ids) { foreach my $class (sort keys %classnames_to_ids) {
@ -104,7 +112,7 @@ foreach my $class (sort keys %classnames_to_ids) {
my $href = $id_to_html{$id}; my $href = $id_to_html{$id};
$index_page =~ /$href">([AB0-9\.]* )/; $index_page =~ /$href">([AB0-9\.]* )/;
my $section = $1 ? "$1" : ""; my $section = $1 ? "$1" : "";
print "$id $href $section\n"; # print "$id $href $section\n";
my $title = $id_to_title{$id}; my $title = $id_to_title{$id};
# print "$section$title\n"; # print "$section$title\n";
print INDEX " <link href='$href' title='$section$title'/>\n"; print INDEX " <link href='$href' title='$section$title'/>\n";
@ -114,3 +122,7 @@ foreach my $class (sort keys %classnames_to_ids) {
} }
print INDEX "</index>\n"; print INDEX "</index>\n";
close INDEX; close INDEX;
print "Generating HTML file...\n"; 
system("xsltproc class-index-html.xsl classindex.xml > class-index.html");

9
docs/manual/src/docbook/namespace-config.xml
View File

@ -9,7 +9,7 @@
<para> Namespace configuration has been available since version 2.0 of the Spring framework. It <para> Namespace configuration has been available since version 2.0 of the Spring framework. It
allows you to supplement the traditional Spring beans application context syntax with elements allows you to supplement the traditional Spring beans application context syntax with elements
from additional XML schema. You can find more information in the Spring <link from additional XML schema. You can find more information in the Spring <link
xlink:href="http://static.springframework.org/spring/docs/2.5.x/reference/xsd-config.html"> xlink:href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/apc.html">
Reference Documentation</link>. A namespace element can be used simply to allow a more Reference Documentation</link>. A namespace element can be used simply to allow a more
concise way of configuring an individual bean or, more powerfully, to define an alternative concise way of configuring an individual bean or, more powerfully, to define an alternative
configuration syntax which more closely matches the problem domain and hides the underlying configuration syntax which more closely matches the problem domain and hides the underlying
@ -687,15 +687,16 @@
<authentication-manager> <authentication-manager>
<authentication-provider ref="casAuthenticationProvider"/> <authentication-provider ref="casAuthenticationProvider"/>
</authentication-manager> </authentication-manager>
<bean id="casAuthenticationProvider" <bean id="casAuthenticationProvider"
class="org.springframework.security.cas.authentication.CasAuthenticationProvider"> class="org.springframework.security.cas.authentication.CasAuthenticationProvider">
... ...
</bean> </bean>
]]></programlisting></para> ]]></programlisting></para>
<para> Another common requirement is that another bean in the context may require a reference to <para> Another common requirement is that another bean in the context may require a reference to
the <interfacename>AuthenticationManager</interfacename>. There is a special element which the <interfacename>AuthenticationManager</interfacename>. You can easily
lets you register an alias for the <interfacename>AuthenticationManager</interfacename> and register an alias for the <interfacename>AuthenticationManager</interfacename> and
you can then use this name elsewhere in your application context. <programlisting language="xml"><![CDATA[ use this name elsewhere in your application context. <programlisting language="xml"><![CDATA[
<security:authentication-manager alias="authenticationManager"> <security:authentication-manager alias="authenticationManager">
... ...
</security:authentication-manager> </security:authentication-manager>