ItEr46S06DocumentacionFormacionItEr45S06: User doc in English and some encoding modifications

doc/src/user/en/01-introducion.rst

@@ -1,5 +1,5 @@
-Introduction
+Introduction
-############
+#############
 
 .. contents::
 

doc/src/user/en/02-criterios.rst

@@ -1,4 +1,4 @@
-Criteria
+Criteria
 #########
 
 .. contents::

doc/src/user/en/03-calendarios.rst

@@ -1,4 +1,4 @@
-Calendars
+Calendars
 ###########
 
 .. contents::
@@ -114,7 +114,7 @@ The following must be carried out to set up a default calendar:
 
 * Go to the *Administration* menu.
 * Click the *Configuration* procedure.
-* Where *Default calendar* appears, select the calendar to be used as the program’s default calendar.
+* Where *Default calendar* appears, select the calendar to be used as the program's default calendar.
 * Click *Save*.
 
 .. figure:: images/default-calendar.png

doc/src/user/en/04-avances.rst

@@ -1,4 +1,4 @@
-Progress
+Progress
 #########
 
 .. contents::

doc/src/user/en/05-recursos.rst

@@ -1,4 +1,4 @@
-Management of resources
+Management of resources
 #######################
 
 .. _recursos:

doc/src/user/en/06-pedidos.rst

@@ -1,4 +1,4 @@
-Orders and order elements
+Orders and order elements
 ##############################
 
 .. contents::
@@ -13,7 +13,7 @@ The following sections will describe the operations that users can carry out wit
 Order
 ======
 
-An order is a project or work that a client requests from a company. The order for the planned works identifies the project in the company.  The difference with comprehensive management programs such as “NavalPlan” is that they only need to use certain order details. These details are:
+An order is a project or work that a client requests from a company. The order for the planned works identifies the project in the company.  The difference with comprehensive management programs such as "NavalPlan" is that they only need to use certain order details. These details are:
 
 * Order name
 * Order code

doc/src/user/en/07-planificacion.rst

@@ -1,4 +1,4 @@
-Task planning
+Task planning
 #######################
 
 .. _planificacion:
@@ -8,7 +8,7 @@
 Task planning
 =============
 
-Planning in “NavalPlan” is a process that has been described throughout all of the chapters of the user guide, the chapters on orders and the assigning of resources being particularly important in this respect. This chapter describes basic planning procedures after the order and the Gantt charts have been configured properly. 
+Planning in "NavalPlan" is a process that has been described throughout all of the chapters of the user guide, the chapters on orders and the assigning of resources being particularly important in this respect. This chapter describes basic planning procedures after the order and the Gantt charts have been configured properly.
 
 .. figure:: images/planning-view.png
    :scale: 35
@@ -34,7 +34,7 @@ The planning view combines three different views:
    * Orange area: Indicating a resource load over 100% as a result of the current project.
    * Yellow area: Indicating a resource load over 100% as a result of other projects.
 
-* Graph view and value gained indicators. These can be viewed from the “Value gained” tab. The generated graph is based on the value gained technique and the indicators that are calculated for each of the workdays of the project. The calculated indicators are:
+* Graph view and value gained indicators. These can be viewed from the "Value gained" tab. The generated graph is based on the value gained technique and the indicators that are calculated for each of the workdays of the project. The calculated indicators are:
 
    * BCWS: accumulative time function for the number of hours planned up to a certain date. It will be 0 at the planned start of the task and the total number of planned hours at the end. As with all accumulative graphs, it will always increase. The function for a task will be the sum of the daily assignments until the calculation day. This function has values for all times, provided that resources have been assigned.
    * ACWP: accumulative time function for the hours attributed in the work reports up to a certain date.  This function will only have a value of 0 before the date of the task's first work report and its value will continue to increase as time passes and work report hours are added. It will have no value after the date of the last work report.
@@ -56,7 +56,7 @@ In the project planning, users can carry out the following procedures:
 
    * Creating a new milestone. Click the task before the milestone that is to be added and select the "Add milestone" option. Milestones can be moved by selecting the task with the mouse pointer and dragging it to the desired position.
    * Moving tasks without disturbing dependencies. Right click the body of the task, and drag it to the desired position. If no restrictions or dependencies are disturbed, the system will update the daily assignment of resources to the task and place the task in the selected date.
-   * Assign restrictions. Click the task in question and select the ”Task properties” option. A *pop-up* will appear with a “Restrictions” field that can be changed. Restrictions can conflict with dependencies, which is why each order states whether dependencies take priority or not over restrictions. The restrictions that can be established are:
+   * Assign restrictions. Click the task in question and select the "Task properties" option. A *pop-up* will appear with a "Restrictions" field that can be changed. Restrictions can conflict with dependencies, which is why each order states whether dependencies take priority or not over restrictions. The restrictions that can be established are:
 
       * *As soon as possible*: Indicating that the task must start as soon as possible.
       * *Not before*. Indicating that the task must not start before a certain date.
@@ -94,7 +94,7 @@ The order list view allows users to go to the order editing and deleting options
 
 Advanced assignment view
 ----------------------------
-The advanced assignment view is explained in depth in the “Resource assignment” chapter.
+The advanced assignment view is explained in depth in the "Resource assignment" chapter.
 
 
 

doc/src/user/en/08-asignacion.rst

@@ -1,4 +1,4 @@
-Assignment of resources
+Assignment of resources
 ########################
 
 .. asigacion_
@@ -64,7 +64,7 @@ To carry out either of the two types of resource assignment, the following steps
 Specific assignment
 ===================
 
-This is the specific assignment of a resource to a project task, i.e. the user decides which specific “name and surname(s)” or “machine” must be assigned to a task.
+This is the specific assignment of a resource to a project task, i.e. the user decides which specific "name and surname(s)" or "machine" must be assigned to a task.
 
 Specific assignment can be carried out on the screen shown in this image:
 
@@ -153,12 +153,12 @@ The steps to follow in order to manage advanced assignments are:
 
 
          * Date. Date on which the segment ends. If the following value is established (length), the date is calculated, alternatively, length is calculated.
-         * Defining the length of each segment. This indicates what percentage of the task’s duration is required for the segment.
+         * Defining the length of each segment. This indicates what percentage of the task's duration is required for the segment.
          * Defining the amount of work. This indicates what workload percentage is expected to be completed in this segment. The quantity of work must be incremental. For example, if there is a 10% segment, the next one must be larger (for example, 20%).
          * Segment graphs and accumulated loads.
 
 
-   * Users then click “Accept”.
+   * Users then click "Accept".
    * The program stores the function and applies it to the daily resource assignments.
 
 .. figure:: images/stretches.png

doc/src/user/en/09-partes.rst

@@ -1,4 +1,4 @@
-Work reports
+Work reports
 #################
 
 .. contents::
@@ -12,7 +12,7 @@ Before being able to add entries for resources, users must at least specify a wo
 Work report type
 ================
 
-A work report has a series of fields that are common to the whole report, and a set of work report lines with specific values for the fields defined in each row. For example, resources and tasks are common to all reports, however, there can be other new fields such as “incidents”, which are not required in all types.
+A work report has a series of fields that are common to the whole report, and a set of work report lines with specific values for the fields defined in each row. For example, resources and tasks are common to all reports, however, there can be other new fields such as "incidents", which are not required in all types.
 
 Users can configure different work report types so that a company can design its reports to meet its own needs:
 
@@ -47,14 +47,14 @@ Users can add new fields to the reports:
 
 Users can configure date, resource and order element fields if they appear in the header of the report, which means they apply to the whole report, or if they are added to each of the rows.
 
-Finally, new additional text fields or tags can be added to the existing ones, in the work report header or in each line, by using the “Additional text” and “Tag type” fields respectively. Users can configure the order in which these elements are to be entered in the “Management of additional fields and tags” tab.
+Finally, new additional text fields or tags can be added to the existing ones, in the work report header or in each line, by using the "Additional text" and "Tag type" fields respectively. Users can configure the order in which these elements are to be entered in the "Management of additional fields and tags" tab.
 
 Work report list
 ================
 
 As soon as the format of the reports to be incorporated into the system have been configured, users can enter the details in the created form according to the structure defined in the corresponding work report type. In order to do this, users need to follow these steps:
 
-* Click the “New work report” button associated with the desired report from the list of work report types.
+* Click the "New work report" button associated with the desired report from the list of work report types.
 * The program then shows the report based on the configurations given for the type. See the following image.
 
 .. figure:: images/work-report-type.png
@@ -68,8 +68,8 @@ As soon as the format of the reports to be incorporated into the system have bee
    * Task code: Code of the task to which the work report is being assigned. Similar to the rest of the fields, if the field is the header, the value is entered once or as many times as necessary on the lines of the report.
    * Date: Date of the report or each line, depending on whether the heading or line is configured.
    * Number of hours. The number of work hours in the project.
-   * Start and finish times. Start and finish times for the work in order to calculate definitive work hours. This field only appears in the case of the hour assignment policies, “According to start and finish times” and ”According to the number of hours and start and finish range”.
+   * Start and finish times. Start and finish times for the work in order to calculate definitive work hours. This field only appears in the case of the hour assignment policies, "According to start and finish times" and "According to the number of hours and start and finish range".
-   * Type of hours: Enabling users to choose the type of hour, e.g. “Normal”, “Extraordinary”, etc.
+   * Type of hours: Enabling users to choose the type of hour, e.g. "Normal", "Extraordinary", etc.
 
 * Click "Save" or "Save and continue".
 

doc/src/user/en/10-etiquetas.rst

@@ -1,4 +1,4 @@
-Tags
+Tags
 #########
 
 .. contents::
@@ -15,7 +15,7 @@ Tag types are used to group the types of tag that users want to manage in the pr
 i. Client: Users may be interested in tagging tasks, orders or order elements in relation to the client who requests them.
 ii. Area: Users may be interested in tagging tasks, orders or order elements in relation to the areas in which they are carried out.
 
-The administration of tag types is managed from the “Administration” menu option. This is where users can edit tag types, create new tag types and add tags to tag types. Users can access the list of tags from this option.
+The administration of tag types is managed from the "Administration" menu option. This is where users can edit tag types, create new tag types and add tags to tag types. Users can access the list of tags from this option.
 
 .. figure:: images/tag-types-list.png
    :scale: 50
@@ -32,11 +32,11 @@ Editing and creating tags share the same form. From this form, the user can assi
 
 i. Select a tag to edit or click the create button for a new one.
 ii. The system shows a form with a text entry for the name and a list of text entries with existing and assigned tags.
-iii. If users wish to add a new tag, they must click on the “New tag” button.
+iii. If users wish to add a new tag, they must click on the "New tag" button.
 iv. The system shows a new row on the list with an empty text box that users must edit.
 v. Users enter a name for the tag.
 vi. The system adds the name to the list.
-vii. Users click “Save” or “Save and continue” to continue editing the form.
+vii. Users click "Save" or "Save and continue" to continue editing the form.
 
 .. figure:: images/tag-types-edition.png
    :scale: 50

doc/src/user/en/11-materiales.rst

@@ -1,4 +1,4 @@
-Materials
+Materials
 ##########
 .. _materiales:
 .. contents::
@@ -13,12 +13,12 @@ The categories are containers that can be assigned specific materials and also m
 
 Users have to do the following to manage categories:
 
-* Go to the “Administration->Materials” option.
+* Go to the "Administration->Materials" option.
 * The program shows a tree of categories.
-* The user enters a category name in the text box and then clicks “Add”.
+* The user enters a category name in the text box and then clicks "Add".
 * The program adds the category to the tree.
 
-If users want to insert a category into the category tree, they have to first select the parent category in the tree and then click “Add”.
+If users want to insert a category into the category tree, they have to first select the parent category in the tree and then click "Add".
 
 .. figure:: images/material.png
    :scale: 50
@@ -27,7 +27,7 @@ If users want to insert a category into the category tree, they have to first se
 
 Users have to do the following to manage materials:
 
-* Select the category to which materials are to be included and click ”Add” to the right of “Materials”.
+* Select the category to which materials are to be included and click "Add" to the right of "Materials".
 * The program adds a new empty row with fields to enter details about the material:
 
    * Code: Material type code (this can be the external code from an ERP).
@@ -37,7 +37,7 @@ Users have to do the following to manage materials:
    * Category: Category to which it belongs.
    * Availability: Whether or not the material has been removed.
 
-* Users complete the fields and click “Save”.
+* Users complete the fields and click "Save".
 
 The assignment of materials to order elements is explained in the chapter on "Orders".
 

doc/src/user/en/12-formularios-calidad.rst

@@ -1,4 +1,4 @@
-Quality forms
+Quality forms
 ######################
 
 .. _calidad:
@@ -19,8 +19,8 @@ Quality forms consist of a list of questions or sentences that indicate the task
 
 Users must carry out the following steps to manage the quality forms:
 
-* From the “Administration” menu, access the “Quality forms” option.
+* From the "Administration" menu, access the "Quality forms" option.
-* Click edit an existing form or “Create”.
+* Click edit an existing form or "Create".
 * The program shows a form with a name, description and type.
 * Select the type.
 * The program shows the fields that are allowed for each type:
@@ -28,7 +28,7 @@ Users must carry out the following steps to manage the quality forms:
    * Percentage: question and percentage.
    * Item: question.
 
-* Click “Save” or “Save and continue”.
+* Click "Save" or "Save and continue".
 
 .. figure:: images/quality.png
    :scale: 50

doc/src/user/en/13-usuarios.rst

@@ -1,4 +1,4 @@
-Users
+Users
 ########
 
 .. _tareas:
@@ -20,24 +20,24 @@ Users have one or several profiles or one or several roles directly so that spec
 
 It is necessary to carry out the following steps to manage users:
 
-* Go to “Manage users” on the “Administration” menu.
+* Go to "Manage users" on the "Administration" menu.
 * The program shows a form with a list of users.
-* Click the editing button for the chosen user or click the “Create” button.
+* Click the editing button for the chosen user or click the "Create" button.
 * A form will appear with the following fields:
 
    * User name.
    * Password
    * Authorised/unauthorised.
    * Email
-   * List of associated roles. Users need to search for one of the roles shown on the selection list and click “Assign” to add a new role.
+   * List of associated roles. Users need to search for one of the roles shown on the selection list and click "Assign" to add a new role.
-   * List of associated profiles. Users need to search for one of the profiles shown on the selection list and click “Assign” to add a new profile.
+   * List of associated profiles. Users need to search for one of the profiles shown on the selection list and click "Assign" to add a new profile.
 
 .. figure:: images/manage-user.png
    :scale: 50
 
    Managing users
 
-* Click “Save” or “Save and continue”.
+* Click "Save" or "Save and continue".
 
 
 Managing profiles
@@ -45,13 +45,13 @@ Managing profiles
 
 Users need to carry out the following steps to manage the program's profiles.
 
-* Go to “Manage user profiles” on the “Administration” menu.
+* Go to "Manage user profiles" on the "Administration" menu.
 * The program shows a list of profiles.
-* Click the editing button for the chosen profile or click “Create”.
+* Click the editing button for the chosen profile or click "Create".
 * A form appears in the program with the following fields:
 
    * Name
-   * List of roles (authorisations) associated with the profile. Users must select a role from the role list and click “Add” to add one that is associated with the profile.
+   * List of roles (authorisations) associated with the profile. Users must select a role from the role list and click "Add" to add one that is associated with the profile.
 
 .. figure:: images/manage-user-profile.png
    :scale: 50

doc/src/user/en/14-custos.rst

@@ -29,7 +29,7 @@ Managing hour types worked
 
 Users need to carry out the following steps to register hour types worked:
 
-* Select “Manage hour types worked ” on the “Administration” menu.
+* Select "Manage hour types worked"  on the "Administration" menu.
 * The program shows a list of existing hour types.
 
 .. figure:: images/hour-type-list.png
@@ -37,7 +37,7 @@ Users need to carry out the following steps to register hour types worked:
 
    Hour type list
 
-* Click “Edit” or “Create”.
+* Click "Edit" or "Create".
 * The program shows an hour type editing form.
 
 .. figure:: images/hour-type-edit.png
@@ -52,14 +52,14 @@ Users need to carry out the following steps to register hour types worked:
    * The default rate.
    * Hour type activation/de-activation.
 
-* Click “Save” or “Save and continue”.
+* Click "Save" or "Save and continue".
 
 Cost categories
 -------------------
 
 Users need to carry out the following steps to register cost categories:
 
-* Select “Manage cost categories” on the “Administration” menu.
+* Select "Manage cost categories" on the "Administration" menu.
 * The program shows a list of existing categories.
 
 .. figure:: images/category-cost-list.png
@@ -67,7 +67,7 @@ Users need to carry out the following steps to register cost categories:
 
    Cost category list
 
-* Click “Edit” or “Create” button.
+* Click "Edit" or "Create" button.
 * The program shows a cost category editing form.
 
 .. figure:: images/category-cost-edit.png
@@ -85,8 +85,8 @@ Users need to carry out the following steps to register cost categories:
       * Start and finish date (the latter is optional) for the period that applies to the cost category.
       * Hourly rate for this specific category
 
-* Click “Save” or “Save and continue”.
+* Click "Save" or "Save and continue".
 
 
-The assignment of cost categories to resources is described in the chapter on resources. Go to the “Resources” section.
+The assignment of cost categories to resources is described in the chapter on resources. Go to the "Resources" section.
 

doc/src/user/en/15-informes.rst

@@ -8,7 +8,7 @@
 Reports
 =======
 
-“NavalPlan” is integrated with *JasperReports* to manage reports, which allows users to enter various reports to analyse available data in the program.
+"NavalPlan" is integrated with *JasperReports* to manage reports, which allows users to enter various reports to analyse available data in the program.
 
 The defined reports are:
 

doc/src/user/en/Makefile

@@ -4,7 +4,7 @@
 #
 
 RST_HTML_FLAGS = --link-stylesheet --stylesheet-path=html/lsr.css
-RST_TEX_FLAGS  = --documentclass=igaliabk --font-encoding=OT1
+RST_TEX_FLAGS  = --documentclass=igaliabk --font-encoding=OT1  --output-encoding=utf-8
 OUTPUT_BASE    = output
 
 rst_srcs   := $(filter-out index.rst,$(wildcard *.rst))

doc/src/user/en/docinfo

@@ -1,16 +1,16 @@
-#######################################
+#############################
-Documentación de usuario da aplicación
+Navalplan: User documentation
-#######################################
+#############################
 
 .. image:: images/logo.png
    :align: left
 
-No seguinte documento proporciónase a documentación de axuda necesaria para utilizar a aplicación de xestión da produción do auxiliar do naval NavalPlan.
+Following document contains necessary help for using Navalplan, the application for production and planning management for Galician ancillary naval industry.
 
-Esta documentación estó organizada do seguinte modo:
+This document is divided in three main sections:
 
-En primeiro lugar descrébense os obxectivos fundamentais da aplicación e o comportamento global da mesma a modo introductorio e como contextualización xeral do uso da mesma.
+First, global goals and behaviour.
 
-A continuación introdúcense as entidades básicas que será necesario administrar para poder empregar todas as funcionalidades de NavalPlan e que se mencionarán nas seguintes seccións da documentación.
+Second, basic entities to understand the minimum concepts to use Navalplan.
 
-Posteriormente, detállanse os procesos completos de creación de pedidos e proxectos, planificación, asignación de recursos, imputación de avances e extración de resultados.
+Finally, complete processes description to create orders, projects, project planning, resources assignment, advance assignment and result extraction.

doc/src/user/es/docinfo

@@ -5,12 +5,12 @@ Documentación de usuario da aplicación
 .. image:: images/logo.png
    :align: left
 
-No seguinte documento proporciónase a documentación de axuda necesaria para utilizar a aplicación de xestión da produción do auxiliar do naval NavalPlan.
+En el siguiente document se proporciona la documentación de ayuda necesaria para utilizar la aplicación de gestión de la producción y planificación del auxiliar del naval Navalplan.
 
-Esta documentación estó organizada do seguinte modo:
+Esta documentación está organizada del siguiente modo:
 
-En primeiro lugar descrébense os obxectivos fundamentais da aplicación e o comportamento global da mesma a modo introductorio e como contextualización xeral do uso da mesma.
+En primer lugar se describen los objetivos principales de la aplicación, comportamiento global y contextualización general del uso y necesidades de la misma.
 
-A continuación introdúcense as entidades básicas que será necesario administrar para poder empregar todas as funcionalidades de NavalPlan e que se mencionarán nas seguintes seccións da documentación.
+A continuación se introducen las entidades básicas que será necesario conocer para utilizar las funcionalidades de Navalplan.
 
-Posteriormente, detállanse os procesos completos de creación de pedidos e proxectos, planificación, asignación de recursos, imputación de avances e extración de resultados.
+Finalmente, se detallan los procesos completos de creación de pedidos, proyectos, planificación de proyectos, asignación de recursos, imputación de avances y extracción de resultados.