Update documentation

app/constants.php

@@ -5,7 +5,7 @@ defined('DEBUG') or define('DEBUG', false);
 defined('DEBUG_FILE') or define('DEBUG_FILE', __DIR__.'/../data/debug.log');
 
 // Application version
-defined('APP_VERSION') or define('APP_VERSION', '1.23');
+defined('APP_VERSION') or define('APP_VERSION', 'master');
 
 // Database driver: sqlite, mysql or postgres
 defined('DB_DRIVER') or define('DB_DRIVER', 'sqlite');

assets/css/src/markdown.css

@@ -69,7 +69,7 @@
     background: #fefefe;
     border: 1px solid #ccc;
     border-radius: 5px;
-    font-size: 1.0em;
+    font-size: 1.1em;
     color: #555;
 }
 
@@ -89,3 +89,7 @@
     border-bottom: 1px solid #ccc;
     margin-bottom: 25px;
 }
+
+.documentation li {
+    line-height: 30px;
+}

doc/application-configuration.markdown

@@ -27,11 +27,12 @@ The list contains all supported timezones by your web server.
 
 Input format used for date fields, by example the due date for tasks.
 
-Kanboard offer 3 different choices:
+Kanboard offer 4 different formats:
 
 - DD/MM/YYYY
 - MM/DD/YYYY (default)
 - YYYY/MM/DD
+- MM.DD.YYYY
 
 The [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format is always accepted (YYYY-MM-DD or YYYY_MM_DD).
 

doc/automatic-actions.markdown

@@ -1,7 +1,7 @@
 Automatic Actions
 =================
 
-To minimize the user interaction, Kanboard support automatic actions.
+To minimize the user interaction, Kanboard support automated actions.
 
 Each automatic action is defined like that:
 
@@ -9,7 +9,7 @@ Each automatic action is defined like that:
 - An action linked to this event
 - Eventually there is some parameters to define
 
-Each project can have a different set of automatic actions, the configuration panel is located on the project listing page, just click on the link **Automatic actions**.
+Each project have a different set of automatic actions, the configuration panel is located on the project listing page, just click on the link **Automatic actions**.
 
 Add a new action
 ----------------

doc/board-horizontal-scrolling-and-compact-view.markdown

@@ -1,7 +1,7 @@
 Horizontal scrolling and compact mode
 =====================================
 
-When the board can't fit on your screen, an horizontal scroll bar will appear at the bottom.
+When the board cannot fit on your screen, an horizontal scroll bar will appear at the bottom.
 
 However, it's possible to switch to the compact the view to display all columns in your screen.
 

doc/contributing.markdown

@@ -57,7 +57,7 @@ Pull-requests are always welcome, however to be accepted you have to follow thos
 - The same apply for the user interface, **simplicity and efficiency**.
 - Send only one pull-request per feature or bug fix, your patch will be merged into one single commit in the master branch.
 - Make sure the [unit tests pass](tests.markdown).
-- Respect the [coding standards](coding-standards.makrdown).
+- Respect the [coding standards](coding-standards.markdown).
 - Write maintainable code, avoid code duplication, use PHP good practices.
 
 In any case, if you are not sure about something open a new ticket.

doc/creating-projects.markdown

@@ -9,11 +9,10 @@ Kanboard can handle multiple projects. There are two kinds of project:
 Creating projects for multiple users
 -------------------------------------
 
-- Only administrators can create those projects
+- Only administrators and project administrators can create those projects
 - User management is available
 
-From the dashboard, click on the link **New project**.
+From the dashboard, click on the link **New project**:
-Then the form appears:
 
 ![Project creation form](http://kanboard.net/screenshots/documentation/project-creation-form.png)
 
@@ -28,4 +27,6 @@ Creating a private project
 
 From the dashboard, click on the link **New private project**.
 
+![New private project](http://kanboard.net/screenshots/documentation/new-private-project.png)
+
 Note: project names must be unique across the application.

doc/editing-projects.markdown

@@ -7,10 +7,9 @@ To rename a project, just click on the link "Edit project" on the left.
 
 ![Project edition](http://kanboard.net/screenshots/documentation/project-edition.png)
 
-Administrators can convert a private project to a multiple users project by changing the checkbox "Private project".
+- The start date and end date are used to generate the project Gantt chart
-You can also do the opposite action converting a multiple users project to a private project.
+- The description is visible as tooltip on the board and on the projects listing page
+- Administrators and project administrators can convert a private project to a multiple users project by changing the checkbox "Private project".
+- You can also convert a multiple users project to a private project.
 
-This checkbox **enable or disable user managements for the project**.
+Note: When you make a project private, all existing users will still have access to the project. Adjust the list of users according to your needs.
-
-Note: When you make a project private, all existing users will still have access to the project.
-Adjust the list of users according to your needs.

doc/gantt-chart-projects.markdown

@@ -6,6 +6,7 @@ The goal of this Gantt chart is to display an overview of all projects based on
 - This Gantt chart is available in the project management section
 - Only project administrators and administrators can access to this section
 - Project administrators will see only projects where they are members
+- Private projects are not shown on this chart
 
 ![Gantt Chart for all projects](http://kanboard.net/screenshots/documentation/gantt-chart-all-projects.png)
 

doc/gantt-chart-tasks.markdown

@@ -3,7 +3,7 @@ Gantt chart for tasks
 
 The goal of this Gantt chart is to display a time based overview of the tasks for a given project.
 
-- The Gantt chart is available from the the action menu
+- The Gantt chart is available from the "view switcher"
 - Only project managers can access to this section
 
 ![Gantt Chart](http://kanboard.net/screenshots/documentation/gantt-chart-project.png)

doc/index.markdown

@@ -12,7 +12,7 @@ Using Kanboard
 
 ### Using the board
 
-- [Board, Calendar and List views](project-views.markdown)
+- [Board, Calendar, List and Gantt views](project-views.markdown)
 - [Collapsed and expanded mode](board-collapsed-expanded.markdown)
 - [Horizontal scrolling and compact mode](board-horizontal-scrolling-and-compact-view.markdown)
 - [Show and hide columns](board-show-hide-columns.markdown)

doc/keyboard-shortcuts.markdown

@@ -1,12 +1,15 @@
 Keyboard shortcuts
 ==================
 
-Board/Calendar/List view
+Keyboard shortcuts availability depends of the page you are presently.
-------------------------
 
-- Switch to the board view = **v b**
+Project views (Board, Calendar, List, Gantt)
+--------------------------------------------
+
+- Switch to the board view = **v b** (press on **v** then **b**)
 - Switch to the calendar view = **v c**
 - Switch to the list view = **v l**
+- Switch to the Gantt view = **v g**
 
 Board view
 ----------
@@ -19,6 +22,7 @@ Application
 -----------
 
 - Open board switcher = **b**
-- Go to the search/filter box = **f**
+- Go to the search box = **f**
+- Reset the search box = **r**
 - Close dialog box = **ESC**
 - Submit a form = **CTRL+ENTER** or **⌘+ENTER**

doc/notifications.markdown

@@ -9,7 +9,7 @@ Kanboard is able to send notifications through several channels:
 - Slack
 
 Actually, Jabber/Hipchat/Slack notifications are sent to a room or group channel because they are configured at the project level.
-However, email notifications are sent to an individual.
+However, email notifications are sent to an individual person.
 
 User notifications
 ------------------

doc/project-permissions.markdown

@@ -8,7 +8,7 @@ A project can have two kinds of people: **project managers** and **project membe
 
 When you create a new project, you are automatically assigned as a project manager.
 
-Kanboard administrators can access to everything but they are not necessary project members or managers. Those permissions are defined at the project level.
+Kanboard administrators can access to everything but they are not necessary project members or managers. **Those permissions are defined at the project level**.
 
 Permissions for each role
 -------------------------

doc/project-views.markdown

@@ -1,7 +1,7 @@
 Board, Calendar and List views
 ==============================
 
-For each project, tasks can be visualized with several views: **Board, Calendar and List**. Each view show the result of the filter box at the top. The search engine use the [advanced syntax](search.markdown).
+For each project, tasks can be visualized with several views: **Board, Calendar, List and Gantt**. Each view show the result of the filter box at the top. The search engine use the [advanced syntax](search.markdown).
 
 Board view
 ----------
@@ -29,9 +29,18 @@ Calendar view
 - [Learn more about calendar configuration](calendar-configuration.markdown)
 
 List view
---------------
+----------
 
 ![List view](http://kanboard.net/screenshots/documentation/list-view.png)
 
 - With this view all results of your search are displayed in a table.
 - You can also use the keyboard shortcut **"v l"** to switch to the list view.
+
+Gantt view
+----------
+
+![Gantt view](http://kanboard.net/screenshots/documentation/gantt-view.png)
+
+- The Gantt view display tasks on a horizontal timeline
+- The start date and the due date are used to display the chart
+- For a quick access, use the keyboard shortcut: **v g**

doc/screenshots.markdown

@@ -22,4 +22,4 @@ On Mac OS X, you can use those shortcuts to take screenshots:
 
 There are also several third-party applications that can be used to take screenshots with annotations and shapes.
 
-**Note: This feature doesn't works with all browsers.**
+**Note: This feature doesn't works with all browsers.** It doesn't work with Safari due to this bug: https://bugs.webkit.org/show_bug.cgi?id=49141

doc/sharing-projects.markdown

@@ -3,8 +3,8 @@ Sharing boards and tasks
 
 By default, boards are private but it's possible to make a board public.
 
-A public board can't be modified, it's a **read-only access**.
+A public board **cannot be modified, it's a read-only access**.
-This access is protected by a random token, only people who have the right token can see the board.
+This access is protected by a random token, only people who have the right url can see the board.
 
 Public boards are automatically refreshed every 60 seconds.
 Task details are also available in read-only.
@@ -32,4 +32,4 @@ When the public access is enabled, a couple of links are generated:
 You can also disable the public access whenever you want.
 
 Each time, you enable or disable the public access a new random token is generated.
-The previous links will not work anymore.
+**The previous links will not work anymore**.

doc/subtasks.markdown

@@ -37,11 +37,8 @@ Note: When the task is closed, all subtasks are changed to the status **Done**.
 Subtask timer
 -------------
 
-Each time a subtask is in progress, the timer is also started. The timer can be started and stopped at any time.
+- Each time a subtask is in progress, the timer is also started. The timer can be started and stopped at any time.
-
+- The timer records the time spent on the subtask automatically. You can also change manually the value of the time spent field when you edit a subtask.
-The timer records the time spent on the subtask automatically. You can also change manually the value of the time spent field when you edit a subtask.
+- The time calculated is rounded to the nearest quarter. This information is recorded in a separate table.
-
+- The task time spent is updated automatically according to the sum of all subtasks time spent.
-The time calculated is rounded to the nearest quarter. This information is recorded in a separate table.
-
-The task time spent is updated automatically according to the sum of all subtasks time spent.
 

doc/update.markdown

@@ -6,7 +6,7 @@ Update
 From the archive (stable version)
 ---------------------------------
 
-1. Close your session (logout)
+1. Close all sessions (logout)
 2. Rename your actual Kanboard directory (to keep a backup)
 3. Uncompress the new archive and copy your `data` directory to the newly uncompressed directory.
 4. Copy your custom `config.php` (if you created one) to the root of the newly uncompressed directory.
@@ -18,7 +18,7 @@ From the archive (stable version)
 From the repository (development version)
 -----------------------------------------
 
-1. Close your session (logout)
+1. Close all sessions
 2. `git pull`
 3. `composer install`
 3. Login and check if everything is ok