Author: echatellier Date: 2009-09-09 12:05:20 +0200 (Wed, 09 Sep 2009) New Revision: 2773 Modified: trunk/src/site/rst/analyse.rst trunk/src/site/rst/architecture.rst trunk/src/site/rst/business.rst trunk/src/site/rst/tutoriel.rst trunk/src/site/rst/ui.rst trunk/src/site/rst/votecounting.rst Log: Quick fix some mistakes Modified: trunk/src/site/rst/analyse.rst =================================================================== --- trunk/src/site/rst/analyse.rst 2009-09-07 09:06:01 UTC (rev 2772) +++ trunk/src/site/rst/analyse.rst 2009-09-09 10:05:20 UTC (rev 2773) @@ -23,7 +23,7 @@ - vote anonymously if we use a restricted list of voters - send reminders to people who did not vote (if restricted voters list) - define begin and end dates for polls. -- define the number of votes possible per personne (1 choice or N choices amongst +- define the number of votes possible per person (1 choice or N choices amongst the propositions) - be able to add a global comment or to his vote. - define, before the vote, the weight of each voter (if restricted voters list) @@ -43,7 +43,7 @@ - Free poll (FreePoll) : the poll is available for anybody. - Restricted poll (RestrictedPoll) : the poll is available only for the restricted list members. - Group poll (GroupPoll) : the poll is available for members of more than one restricted list. -- Vote : answer from a votter to the question, this answer is stored before beeing +- Vote : answer from a voter to the question, this answer is stored before beeing processed, the voters identity is then known. - Anonymous vote (AnonymousVote) : answer from a voter to the question asked without knowing the voter's identity. - Vote counting type (VoteCounting) : Poll results utilizing, the vote counting can be done @@ -98,7 +98,7 @@ Giving its identity when voting anonymously can annoy the voter. So in the case of an anonymous vote, the voter will identify himself with a anonymity number. The voter does not know how the application works for anonymous votes, this -approach will reinsure him regarding his annonimity. +approach will reinsure him regarding his anonymity. Functionalities (Use cases) ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -156,14 +156,14 @@ Variations :: 1a. The user authenticate himself. - 1a1. If the user is black-listed, the connexion is impossible, an error message is displayed. + 1a1. If the user is black-listed, the connection is impossible, an error message is displayed. 2a. The user chose a restricted type poll. 2a1. The user chose a predefined list. - The user can balance each voter of the list for the poll. 2a2. The user chose several predefined lists (groups). - The user can balance each voter of each group. - The user can balance each group. - 2a3. The user chose to create a restricted list by filling in voters name and email adress. + 2a3. The user chose to create a restricted list by filling in voters name and email address. The user specifies if choices can be added by voters. The user specifies if it is an anonymous poll. 5a. If user is blacklisted, creation is not possible, an error message is shown. @@ -174,7 +174,7 @@ 10a. If the user is authenticated or filled his email in, the system ask if the user wants to receive an email for each vote. 11a. If the user filled in his email, an emails with the 2 poll's URLs is automatically sent to the poll creator. 11b. If the user is authenticated, an email with the 2 poll's URLs is automatically sent when the poll is created. - 11c. In the case of a poll on a restriucted list, an email with a link to vote and the voters login is sent to every voter of the poll. + 11c. In the case of a poll on a restricted list, an email with a link to vote and the voters login is sent to every voter of the poll. 12a. The non authenticated user does not save the URLs : the user cannot reach the polls anymore. 13a. If the poll is unvalidated by the administrator : the poll is deleted, the URL cannot be reached anymore. If the user gave authentication information or is logged, he is blacklisted. @@ -216,9 +216,9 @@ Variations :: - 2a. If the poll is restricted and this option is autorised on the current poll, the voter can add a poll choice. The poll creator and all the participants are alerted by email of the poll modification. + 2a. If the poll is restricted and this option is authorised on the current poll, the voter can add a poll choice. The poll creator and all the participants are alerted by email of the poll modification. 4a. If the voter did not filled in a valid login : an error message is shown, the vote is not counted. - 4b. If the voter is black listed by the poll creator, he is not allowed to vote : an error emssage is shown, the vote is not taken into account. + 4b. If the voter is black listed by the poll creator, he is not allowed to vote : an error message is shown, the vote is not taken into account. Extensions :: @@ -246,7 +246,7 @@ 1. The user can connect to the poll by the URL. 2. The user chose to count the votes. -3. The application runs the vote counting algorythm. +3. The application runs the vote counting algorithm. 4. The results (voters, answers) of the poll are displayed. Variations :: @@ -281,7 +281,7 @@ - The system have to store and restore manipulated informations : a DBMS use will manage those needs. - The application will not by strongly linked to any DBMS on the market : the -use of a persitence layer is mandatory. +use of a persistence layer is mandatory. - The application have to be service oriented, all the business layer will be separated from the presentation layer. - The system have to insure full security to the user for transactions done from Modified: trunk/src/site/rst/architecture.rst =================================================================== --- trunk/src/site/rst/architecture.rst 2009-09-07 09:06:01 UTC (rev 2772) +++ trunk/src/site/rst/architecture.rst 2009-09-09 10:05:20 UTC (rev 2773) @@ -44,7 +44,7 @@ - ServiceManagerUser : Users management service (for users having an account) - ServiceList : Voters list management service (groups, bookmarks,...) - ServicePoll : Poll management service : Creation/Modification/Deletion/Moderation... -- ServiceVote : votes management service (Functionalities availale for a voter) +- ServiceVote : votes management service (Functionalities available for a voter) - ServiceResults : Result management service - ServiceComment : Comments management service. Modified: trunk/src/site/rst/business.rst =================================================================== --- trunk/src/site/rst/business.rst 2009-09-07 09:06:01 UTC (rev 2772) +++ trunk/src/site/rst/business.rst 2009-09-09 10:05:20 UTC (rev 2773) @@ -8,9 +8,9 @@ DTO --- -The dto package does the communication between the web client and the persitence +The dto package does the communication between the web client and the persistence part of the application. -For maintanability and uncoupling needs, the client does not manipulate directly +For maintainability and uncoupling needs, the client does not manipulate directly database objects and so use a simplified representation of the entities located in the persistence layer. @@ -30,7 +30,7 @@ -------- In our service oriented architecture, the services are a facade giving access to -the persitence management to the client, it shows a certain number of operations, +the persistence management to the client, it shows a certain number of operations, hidding their implementation to the client. To do so, it is based on the DTO pattern to exchange info with it. @@ -60,8 +60,8 @@ Persistence ----------- -Using ToPIA-Persistence API, we have to manage a global context laoding the JDBC -connection to the dabase properties and creating sub-contexts used for +Using ToPIA-Persistence API, we have to manage a global context loading the JDBC +connection to the database properties and creating sub-contexts used for transactions to the database. The global persistence context for the application is managed under a singleton Modified: trunk/src/site/rst/tutoriel.rst =================================================================== --- trunk/src/site/rst/tutoriel.rst 2009-09-07 09:06:01 UTC (rev 2772) +++ trunk/src/site/rst/tutoriel.rst 2009-09-09 10:05:20 UTC (rev 2773) @@ -10,7 +10,7 @@ - creation - vote -- results visualisation +- results visualization Creation -------- Modified: trunk/src/site/rst/ui.rst =================================================================== --- trunk/src/site/rst/ui.rst 2009-09-07 09:06:01 UTC (rev 2772) +++ trunk/src/site/rst/ui.rst 2009-09-09 10:05:20 UTC (rev 2773) @@ -210,7 +210,7 @@ The votes on pictures needs to allow pictures uploading on the server. The Tapestry Upload component allows to do that easily by placing it into a form and by saving -the file sublited (UploadedFile) in a servers'directory. Moreover it is possible +the file submitted (UploadedFile) in a servers'directory. Moreover it is possible to limit the size of the files in the AppModule class (*contibuteApplicationDefaults()* method):: configuration.add(UploadSymbols.FILESIZE_MAX, "500000"); @@ -219,7 +219,7 @@ The thumbnail corresponding to the image is created once and for all when it is submitted so that the server is not on his kees because he change the image dimensions each time someone displays the page (image a page with 10 2Mb images). -But it is not so easy to display thos images after beacause of Tapestry's behavior. +But it is not so easy to display those images after because of Tapestry's behavior. An Image component have then be created to fulfill this need. Results Modified: trunk/src/site/rst/votecounting.rst =================================================================== --- trunk/src/site/rst/votecounting.rst 2009-09-07 09:06:01 UTC (rev 2772) +++ trunk/src/site/rst/votecounting.rst 2009-09-09 10:05:20 UTC (rev 2773) @@ -96,7 +96,7 @@ - PercentageMethod : Vote counting using choices balancing. Each method implements the "executeMethod(choices)" operation that will be called -in the Context class by the "exectute()" method. +in the Context class by the "execute()" method. So the context needs to know all the choices and the votes by choice and by group. When calling for ServiceVoteCounting, a new context will be created and the @@ -187,4 +187,4 @@ export. Have a look to the following class diagram : .. image:: schemas/votecounting/DC_ServiceExportXML.png - :alt: Class diagram of a poll and its reults export + :alt: Class diagram of a poll and its results export