smartweb-devel

[smartweb-devel] How to organize the Smartweb User's Guide

[Gaetano P. <gpe...@sm...>]

Following the struts / hibernate approch to the user's guide i think about
something of there:


1. Introducing Smartweb framework

2. Architecture

3. Setup and configuration


  4. Building Model Component
    

	
4.1. Overview
    
4.2. Java Beans and scope
    
4.3. Business Logic domains
	


5. Building persistence layer with hibernate 

	
5.1. Overview
  
5.2. Mapping persistence class wih hibernate and xdoclet
  
5.3. Getting started with BusinessObjectFactory

  6. Building view components with struts
  

  
6.1. Overview
  
6.2. Forms and FormBeans interactionsv
  
6.3. Internationalization and presentation tag library inherited from Struts
  
6.4. Query results paging
  
6.5. Forms validation
  

  7. Building controller components
  

  
7.1. Overview
   
7.2. Writing action mapping
   
7.3. Getting started with AbstractArchiveAction 
  

  8. Getting started with samples

  //TODO
  

9. Handle application access privilege with auth module
  

  
9.1. Overview
  
9.2. Setup and configuration
  
9.3. The auth domain
 
9.4. Administration pages
  
9.5. Getting started with auth samples
  

  10. Registry module 
  

  
10.1. Overview
  
10.2. Setup and configuration
  
10.3. The registry domain
  
10.4. Getting started with auth samples 
  

  11. Best practice
  

  
11.1 Handle transaction
  
11.2 Where place business rule?
  
11.3 Using criteria, hql or sql queries
  
11.4 Wrapping domains with stateless session bean
  

-- 
View this message in context: http://www.nabble.com/How-to-organize-the-Smartweb-User%27s-Guide-tf4697476s17546.html#a13427690
Sent from the SmartWeb Developers mailing list archive at Nabble.com.

Re: [smartweb-devel] How to organize the Smartweb User's Guide

[Pino C. <gco...@gm...>]

I fully agree on the structure of documentation.
I was wondering how you would set the example chapter .
Have you in mind to implement a  guide project step by step or something
like that?
In any event you can count on my help ..say what I've to do and I'll do it


Gaetano Perrone wrote:
> 
> <p><strong>Following the struts / hibernate approch to the user's guide i
> think about something of there:</strong><br />
> </p>
> 1. Introducing Smartweb framework
> <br /><br />
> 2. Architecture<br /><br />
> 3. Setup and configuration<br /><br />
> 
>   4. Building Model Component
>     <ul>
> 	<li>4.1. Overview</li>
>     <li>4.2. Java Beans and scope</li>
>     <li>4.3. Business Logic domains</li>
> 	</ul>
> </blockquote>
> 5. Building persistence layer with hibernate 
> <ul>
> 	<li>5.1. Overview</li>
>   <li>5.2. Mapping persistence class wih hibernate and xdoclet</li>
>   <li>5.3. Getting started with BusinessObjectFactory</li>
> </ul>
>   6. Building view components with struts
>   <ul>
>   <li>6.1. Overview</li>
>   <li>6.2. Forms and FormBeans interactionsv
>   <li>6.3. Internationalization and presentation tag library inherited
> from Struts</li>
>   <li>6.4. Query results paging</li>
>   <li>6.5. Forms validation</li>
>   </ul>
>   7. Building controller components
>   <ul>
>   <li>7.1. Overview</li>
>    <li>7.2. Writing action mapping</li>
>    <li>7.3. Getting started with AbstractArchiveAction </li>
>   </ul>
>   8. Getting started with samples<br />
>   //TODO
>   <br /><br />
> 9. Handle application access privilege with auth module
>   <ul>
>   <li>9.1. Overview</li>
>   <li>9.2. Setup and configuration</li>
>   <li>9.3. The auth domain</li>
>  <li>9.4. Administration pages</li>
>   <li>9.5. Getting started with auth samples</li>
>   </ul>
>   10. Registry module 
>   <ul>
>   <li>10.1. Overview</li>
>   <li>10.2. Setup and configuration</li>
>   <li>10.3. The registry domain</li>
>   <li>10.4. Getting started with auth samples </li>
>   </ul>
>   11. Best practice
>   <ul>
>   <li>11.1 Handle transaction</li>
>   <li>11.2 Where place business rule?</li>
>   <li>11.3 Using criteria, hql or sql queries</li>
>   <li>11.4 Wrapping domains with stateless session bean</li>
>   </ul>
> 

-- 
View this message in context: http://www.nabble.com/How-to-organize-the-Smartweb-User%27s-Guide-tf4697476s17546.html#a13489161
Sent from the SmartWeb Developers mailing list archive at Nabble.com.

Re: [smartweb-devel] How to organize the Smartweb User's Guide

[amarini <ann...@gm...>]

>From the key it seems to be a lot of things, I would like to see the
contents, as they turn out, if they are simple, clear and comprehensible, i=
f
they are not wasteful =E2=80=A6 are they yet ready?=20
As they are listed, they seem self-supporting one from one another, it is
therefore? I want to say can I watch for example n=C2=B0 7 without having s=
een n=C2=B0
4 and understand it? Otherwise they would go nested=E2=80=A6 according to t=
heir
possible use, also even repeated inside the different coherent arguments=E2=
=80=A6


Gaetano Perrone wrote:
>=20
> <p><strong>Following the struts / hibernate approch to the user's guide i
> think about something of there:</strong><br />
> </p>
> 1. Introducing Smartweb framework
> <br /><br />
> 2. Architecture<br /><br />
> 3. Setup and configuration<br /><br />
>=20
>   4. Building Model Component
>     <ul>
> =09<li>4.1. Overview</li>
>     <li>4.2. Java Beans and scope</li>
>     <li>4.3. Business Logic domains</li>
> =09</ul>
> </blockquote>
> 5. Building persistence layer with hibernate=20
> <ul>
> =09<li>5.1. Overview</li>
>   <li>5.2. Mapping persistence class wih hibernate and xdoclet</li>
>   <li>5.3. Getting started with BusinessObjectFactory</li>
> </ul>
>   6. Building view components with struts
>   <ul>
>   <li>6.1. Overview</li>
>   <li>6.2. Forms and FormBeans interactionsv
>   <li>6.3. Internationalization and presentation tag library inherited
> from Struts</li>
>   <li>6.4. Query results paging</li>
>   <li>6.5. Forms validation</li>
>   </ul>
>   7. Building controller components
>   <ul>
>   <li>7.1. Overview</li>
>    <li>7.2. Writing action mapping</li>
>    <li>7.3. Getting started with AbstractArchiveAction </li>
>   </ul>
>   8. Getting started with samples<br />
>   //TODO
>   <br /><br />
> 9. Handle application access privilege with auth module
>   <ul>
>   <li>9.1. Overview</li>
>   <li>9.2. Setup and configuration</li>
>   <li>9.3. The auth domain</li>
>  <li>9.4. Administration pages</li>
>   <li>9.5. Getting started with auth samples</li>
>   </ul>
>   10. Registry module=20
>   <ul>
>   <li>10.1. Overview</li>
>   <li>10.2. Setup and configuration</li>
>   <li>10.3. The registry domain</li>
>   <li>10.4. Getting started with auth samples </li>
>   </ul>
>   11. Best practice
>   <ul>
>   <li>11.1 Handle transaction</li>
>   <li>11.2 Where place business rule?</li>
>   <li>11.3 Using criteria, hql or sql queries</li>
>   <li>11.4 Wrapping domains with stateless session bean</li>
>   </ul>
>=20

--=20
View this message in context: http://www.nabble.com/How-to-organize-the-Sma=
rtweb-User%27s-Guide-tf4697476s17546.html#a13489201
Sent from the SmartWeb Developers mailing list archive at Nabble.com.

Re: [smartweb-devel] How to organize the Smartweb User's Guide

[rlogiacco <rlo...@us...>]

Gaetano Perrone wrote:
> 
> <p><strong>Following the struts / hibernate approch to the user's guide i
> think about something of there:</strong><br />
> </p>
>   (omissis)
> 

I think the structure is almost ok, I suggest not to mention every module in
here but delegate modules user-guides to modules themselves, I would mention
explicitly here only the auth and i18n modules which are actually more
architectural than the others which are more functional.

Another suggestion I can post is about the examples, which must not be
something like a tutorial (we have another section for that).
-- 
View this message in context: http://www.nabble.com/How-to-organize-the-Smartweb-User%27s-Guide-tf4697476s17546.html#a13489207
Sent from the SmartWeb Developers mailing list archive at Nabble.com.

Re: [smartweb-devel] How to organize the Smartweb User's Guide

[amarini <ann...@gm...>]

Hello to all, I want to resume the speech on SmartWeb documentation and
update you on the made considerations :working:.

I have thought next to the new Home Page and I would propose you to revisit
it maintaining some already current information and putting four lateral box
(to catch the attention) including what is currently under Quick Start (see 
http://www.nabble.com/file/p16349330/Home.doc Home.doc ). Obviously we will
not be able to made it in .apt :confused: Have you some idea?

What about the User Guide? I have preserved the structure proposed from
Gaetano and prepared some .apt, therefore I would replace the current
user-guide.html (whose information will be integrated to the first point
‘introducing.html’) with the new one and I would cut out the voices
‘architecture’ and ‘config guide’ from the area documentation placed on the
left as they will be respectively integrated to the second and the third
point of the new User Guide. 

If you agree, I would prepare all the .apt. Someone between you can generate
the new Home Page? :handshake:

-- 
View this message in context: http://www.nabble.com/How-to-organize-the-Smartweb-User%27s-Guide-tp13427690s17546p16349330.html
Sent from the SmartWeb Developers mailing list archive at Nabble.com.

Re: [smartweb-devel] How to organize the Smartweb User's Guide

[Roberto Lo G. <rlo...@sm...>]

2008/3/28, amarini <ann...@gm...>:
>  Hello to all, I want to resume the speech on SmartWeb documentation and
>  update you on the made considerations :working:.

Good news for us all!

>  I have thought next to the new Home Page and I would propose you to revisit
>  it maintaining some already current information and putting four lateral box
>  (to catch the attention) including what is currently under Quick Start (see
>  http://www.nabble.com/file/p16349330/Home.doc Home.doc ). Obviously we will
>  not be able to made it in .apt :confused: Have you some idea?

I can think to xdoc format, but we need to double check.

>  What about the User Guide? I have preserved the structure proposed from
>  Gaetano and prepared some .apt, therefore I would replace the current
>  user-guide.html (whose information will be integrated to the first point
>  'introducing.html') with the new one and I would cut out the voices
>  'architecture' and 'config guide' from the area documentation placed on the
>  left as they will be respectively integrated to the second and the third
>  point of the new User Guide.
>
>  If you agree, I would prepare all the .apt. Someone between you can generate
>  the new Home Page? :handshake:

I agree with you! I llok forward for your commit to have the
opportunity to review and integrate with our contributions. Thank you
Anna!

-- 
   Roberto Lo Giacco

Re: [smartweb-devel] How to organize the Smartweb User's Guide

[Roberto Lo G. <rlo...@sm...>]

2008/3/28, amarini <ann...@gm...>:
>  If you agree, I would prepare all the .apt. Someone between you can generate
>  the new Home Page? :handshake:

I'll try to give a check to xdoc format later today, in the meanwhile
I wish to suggest you to have a look at the two documents inside the
doc folder: they are obsolete and in italian, but I think they could
provide you some hints anyway.

-- 
   Roberto Lo Giacco

Re: [smartweb-devel] How to organize the Smartweb User's Guide

[Roberto Lo G. <rlo...@us...>]

Roberto Lo Giacco-4 wrote:
> 
> 2008/3/28, amarini <ann...@gm...>:
>>  If you agree, I would prepare all the .apt. Someone between you can
>> generate
>>  the new Home Page? :handshake:
> 
> I'll try to give a check to xdoc format later today, in the meanwhile
> I wish to suggest you to have a look at the two documents inside the
> doc folder: they are obsolete and in italian, but I think they could
> provide you some hints anyway.
> 

Well, I've done a first check and I've found the XDOC format is perfect for
the task. I'm starting right now to move the index page from APT to XDOC.

I think I'll regenerate and update the project and modules website tomorrow.

-- 
View this message in context: http://www.nabble.com/How-to-organize-the-Smartweb-User%27s-Guide-tp13427690s17546p16853898.html
Sent from the SmartWeb Developers mailing list archive at Nabble.com.