[claw-cvs] r166 - trunk/doc/chapters
Andrea Chiumenti
achiumenti at common-lisp.net
Mon Dec 22 10:51:58 UTC 2008
Author: achiumenti
Date: Mon Dec 22 10:51:49 2008
New Revision: 166
Log:
documentation spellcheck
Modified:
trunk/doc/chapters/claw-html.texinfo
trunk/doc/chapters/server.texinfo
Modified: trunk/doc/chapters/claw-html.texinfo
==============================================================================
--- trunk/doc/chapters/claw-html.texinfo (original)
+++ trunk/doc/chapters/claw-html.texinfo Mon Dec 22 10:51:49 2008
@@ -18,7 +18,7 @@
If you don't have any idea of what asdf is, please read about it at the @url{http://constantly.at/lisp/asdf/, asdf Manual}.
Create a directory named @code{clhtml-sample1} and begin writing the @code{clhtml-sample1.asd} file and create a symbolic link
-into the asdf system directory.
+in the asdf system directory.
@sp 2
@smalllisp
@@ -70,7 +70,7 @@
The package exports the symbol functions @code{CLHTML-SAMPLE1-START} and @code{CLHTML-SAMPLE1-STOP}, used to
start and stop the application server.
-This two function will be defined into the @code{main.lisp} file.
+This two functions will be defined into the @code{main.lisp} file.
Now it's time to write the code do launch the application server and register the lisplet.
Fill the @code{main.lisp} file with the following code
@@ -144,7 +144,7 @@
@section Your first @code{claw-html} page
-It's time to create your first page using @code{claw-html} this is done creating a @code{PAGE} subclass, override its
+It's time to create your first page using @code{claw-html} this is done by creating a @code{PAGE} subclass, override its
@code{page-content} method and finally registering it using the @code{make-page-renderer} function.
In this very basic example we will not use any of the component feature of the framework, just basic tag functions.
@@ -231,7 +231,7 @@
@subsection Creating your first component
Writing a page the way described before has been straightforward, but it doesn't show any of
-the framework potentialities. Effectively this is nothing more then what other framework offers.
+the framework potentialities. Effectively this is nothing more than what other framework offers.
So let's do what is usually done by component-based frameworks: create the first component.
This will be the site template component, surely you don't want to write every page to be
@@ -259,7 +259,7 @@
Since you haven't provided any @code{DEFAULT-INITARGS}, if you forgot to provide the title attribute to your tag function, the
page won't render, and an error message will be logged.
-Surely the class does very little by itself without a proper template, so you'll define one for it now.
+Obviously the class does very little by itself without a proper template, so you'll define one for it now.
@sp 2
@smalllisp
@@ -280,8 +280,8 @@
@code{CALW-HTML} can control the id of each component so that when a component is put into a page, its id is not duplicated. You can avoid this checking using the
@code{STATIC-ID} attribute, so when writing a component you can use the id given to your component through @code{HTCOMPONENT-CLIENT-ID} method an render it into the
-component template (or other component methods of course). This is a great point of strength for @code{claw-html} compared to other frameworks, in fact when you put
-your component into a collecting loop without being worry, about id duplications, a situation that might occur for example when creating table row components.
+component template (or other component methods of course). This is a great point of strength for @code{claw-html} compared to other frameworks,
+, such as using the component in a loop without needing to worry about id duplication, a situation that might occur for example when creating table cells.
The last thing to note is the absence of the link to the css file. This was made because each component can inject into the page its own css or js files or definitions.
@@ -319,7 +319,7 @@
So, you may have now no repetitions of the html tag elements between application pages, a shorter @code{PAGE-CONTENT} implementation,
and no problems about forgetting to import common stylesheet files (and .js files if you need one).
-For curiosity here it is the html source output:
+For curiosity here is the html source output:
@sp 1
@image{images/idxpage-src,150mm,,,png}
@@ -398,7 +398,7 @@
@end smalllisp
@sp 2
-As you can see, once inserted into your component no more javascript is needed, the injection system will do all needed for you!
+As you can see, once inserted into your component no more javascript is needed, the injection system will do everything for you!
Here it is how the page will look like:
@@ -430,7 +430,7 @@
@sp 2
As you can see from the following source code css and javascript @code{SHOW-TIME} injections are correctly handled and not
-duplicated as it is for the id generations that do not create conflicts.
+duplicated as it is for the id generation that do not create conflicts.
@sp 1
@image{images/idxpage-showtime-src,150mm,,,png}
Modified: trunk/doc/chapters/server.texinfo
==============================================================================
--- trunk/doc/chapters/server.texinfo (original)
+++ trunk/doc/chapters/server.texinfo Mon Dec 22 10:51:49 2008
@@ -96,7 +96,7 @@
@value{claw} has the notion of lisplets, components similar to java servlets, but written in Common Lisp.
As the name suggests, a lisplet is defined by the @code{LISPLET} class. A lisplet is an envelop for your application, so
- at code{claw-server}, being an application server, may hold more then one web application, each sharing or protecting its realm with
+ at code{claw-server}, being an application server, may hold more than one web application, each sharing or protecting its realm with
other web applications. This means that an application may or may not share user sessions among the others, configuring its own realm.
A lisplet contains all the resources (dynamic pages, static files, and services) that your application may need.
@@ -283,7 +283,7 @@
This again is another easy task, simply use @code{LISPLET-REGISTER-FUNCTION-LOCATION} as you did for the two pages in the example of the previous chapter.
-To get an example of this, download a jpg image and put it under the /tmp directory, naming it 'foo.jpg'. Then use the following code to register it
+To see an example of this, download a jpg image and put it under the /tmp directory, naming it 'foo.jpg'. Then use the following code to register it
into your servlet.
@sp 2
@@ -301,7 +301,7 @@
@end smalllisp
@sp 2
-Now you can access your ``generated'' image pointing your browser at the url @indicateurl{http://localhost:4242/claw/demo/images/foo.bar}.
+Now you can access your ``generated'' image by pointing your browser at the url @indicateurl{http://localhost:4242/claw/demo/images/foo.bar}.
Though you have called the image ``foo.bar'', since you have provided the resource registration setting its content type with ``image/jpeg'',
it is rendered as a normal jpeg image even if its extension is ``.bar''.
@@ -314,7 +314,7 @@
An example of a @value{claw} library is the @emph{claw-html.dojo} library that extends the @emph{claw-html} web framework and
provides all the @url{http://www.dojotoolkit.org, dojo} resources to the server web applications.
-Defining a system wide resource is not so different from defining a local one. The following code gives you an example on how to do.
+Defining a system wide resource is not so different to a local one: the following code gives you an example on how to do.
@sp 2
@smalllisp
@@ -325,7 +325,7 @@
One difference from a local and a system wide resource is that @code{REGISTER-LIBRARY-RESOURCE} registers the resource at the application server level
and not at the lisplet level.
-This implies that the resource in your example is available at the following url @indicateurl{http://localhost:4242/claw/tempdir/hunchentoot.log} to clarify.
+This means that the resource in the example is available at the following url @indicateurl{http://localhost:4242/claw/tempdir/hunchentoot.log}.
@section Authentication and authorization
@@ -339,7 +339,7 @@
@value{claw} may handle both @emph{basic} an @emph{form based} authentication types, you'll begin to see a basic authentication and then will change
it into a form based one.
-Now begin defining a @code{CONFIGURATION} subclass implementing its @code{CONFIGURATION-LOGIN} method and add it to your previous sample sample.
+Now begin defining a @code{CONFIGURATION} subclass implementing its @code{CONFIGURATION-LOGIN} method and add it to your previous sample.
@sp 2
@smalllisp
@@ -363,8 +363,8 @@
@sp 2
As for any other resource you have to register the @code{CONFIGURATION}, but not into your lisplet, instead the
- at code{CONFIGURATION} must be registered into the @value{claw} application server because it is cross-application,
-that means that more then one lisplet may share the same authentication configuration.
+ at code{CONFIGURATION} must be registered with the @value{claw} application server; because it is cross-application,
+that means that more than one lisplet may share the same authentication configuration.
@sp 2
@smalllisp
@@ -382,7 +382,7 @@
The @code{LISPLET-AUTHENTICATION-TYPE} method returns @code{:BASIC} when the authentication type is @emph{basic}, while
it returns @code{:FORM} when it is @emph{form based}.
-When the authentication type is @emph{basic} the @code{CLAW-AUTHORIZATION} function returns a value pair, containing the passed user name and password, while, when the authentication type is @emph{form based}, user name and password
+When the authentication type is @emph{basic} the @code{CLAW-AUTHORIZATION} function returns a value pair, containing the passed user name and password, whereas, when the authentication type is @emph{form based}, user name and password
are retrieved from the http request.
To get a parameter from the http request claw provides three methods.
@@ -398,7 +398,7 @@
Now you only need to protect some resource into your lisplet, so you'll now add a new one into your sample and protect it with the newly defined configuration.
-Firstly you'll try the @emph{basic} authentication mode, to witch then to the @emph{form based} one.
+Firstly you'll try the @emph{basic} authentication mode, then the @emph{form based} one.
@sp 2
@smalllisp
@@ -547,15 +547,15 @@
@end smalllisp
@sp 2
-A note about @emph{(setf (current-principal) ...)} must be taken; this line in fact stores the newly created principal into the lisplet session.
+Please note, with respect to @emph{(setf (current-principal) ...)} that stores the newly created principal into the lisplet session.
The method @code{LISPLET-PROTECT} protects a given resource, identified by its lisplet-relative uri, against a list of given roles. In the current
example the page ``protected.html'' will be available only to users that belong to the ``admin-role'' and ``user-role''.
The function @code{USER-IN-ROLE-P} checks if the principal returned by the function @code{CURRENT-PRINCIPAL}, belongs to at least one of the given roles.
-This method is useful to conditional filling you html page, as you just did in the sample above.
+This method is useful for conditionally including content,as we did above.
-Now it's time to move the demo lisplet to a form based authentication.
+Now it's time to move the demo lisplet to form based authentication.
The @emph{form based} authentication method is not much more difficult from the @emph{basic} one, you just have to crate
a form that calls the @code{CONFIGURATION-LOGIN} of the configuration retrieved by the @code{CURRENT-CONFIGURATION} function.
@@ -590,14 +590,14 @@
@end smalllisp
@sp 2
-This is not much more then the effort for using the @emph{basic} authentication method.
+This is not much more than the effort for using the @emph{basic} authentication method.
You have only to notice that the @code{name} tag attribute of the input boxes for username and password must match the parameters
expected into the @code{CONFIGURATION-LOGIN} method implementation. For this example they are in fact ``username'' and ``password''.
-The lo gout phase is even more simple, you only need to destroy the user session calling the function @code{claw-remove-session}.
+The logout phase is even more simple, you only need to destroy the user session calling the function @code{claw-remove-session}.
-So putting all together
+So putting it all together
@sp 2
@smalllisp
@@ -751,7 +751,7 @@
@end smalllisp
@sp 2
-Of course you can protect entire branches of you applications, this is done protecting the uri location, for example you could protect all resources into
+Of course you can protect entire branches of your applications, this is done by protecting the uri location, for example to protect all resources in the
'private' forlder.
@sp 2
@@ -764,13 +764,13 @@
@value{claw} is able to pass connection over the @code{HTTPS} protocol and to manage sessions and services between @code{HTTP} and @code{HTTPS}.
-To make the server listen for https requests incoming you will have to provide it at least a @code{sslport}
+To make the server listen for incoming https requests you will have to provide it at least a @code{sslport}
With the hunhcentoot connector if you don't pass through Apache mod_proxy you'll also have to pass it @code{ssl-certificate-file}, @code{ssl-privatekey-file} and , eventually, a @code{ssl-privatekey-password} parameter if the certificate is password protected. Of course you can also use Apache SSL certificate files.
-To generate your own certificate files under Linux operating system, you can use openssl to get one in the way described below.
+To generate your own certificate files under Linux operating system, you can use openssl as described below.
-Firstly you'll generate the private key file:
+First generate the private key file:
@sp 2
@smallexample
@@ -828,7 +828,7 @@
@code{sslport}.
Another great feature of the @value{claw} application server is the ability to automatically redirect requests to protected resources through the @code{HTTPS} protocol.
-This is made extremely easy setting to @emph{true} the @code{REDIRECT-PROTECTED-RESOURCES-P} lisplet parameter like in the following example
+This is done extremely easy by setting the @code{REDIRECT-PROTECTED-RESOURCES-P} lisplet parameter to @emph{true} like in the following example
@sp 2
@smalllisp
More information about the Claw-cvs
mailing list