From 6c711f696f73bc59813f6834ec241aef3b626cbd Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Sat, 29 Aug 2015 20:00:53 -0400
Subject: Include documentation in the application

---
 app/Template/app/filters_helper.php                 |  3 +--
 app/Template/category/edit.php                      |  2 +-
 app/Template/column/edit.php                        |  2 +-
 app/Template/column/index.php                       |  2 +-
 app/Template/comment/create.php                     |  2 +-
 app/Template/comment/edit.php                       |  2 +-
 app/Template/config/integrations.php                | 18 +++++++++---------
 app/Template/config/sidebar.php                     |  3 +++
 app/Template/doc/show.php                           | 13 +++++++++++++
 app/Template/project/edit.php                       |  2 +-
 app/Template/project/integrations.php               | 12 ++++++------
 app/Template/project/users.php                      |  1 +
 app/Template/search/index.php                       |  2 +-
 app/Template/task_creation/form.php                 |  2 +-
 app/Template/task_modification/edit_description.php |  2 +-
 15 files changed, 42 insertions(+), 26 deletions(-)
 create mode 100644 app/Template/doc/show.php

(limited to 'app/Template')

diff --git a/app/Template/app/filters_helper.php b/app/Template/app/filters_helper.php
index b7a0bba6..529aa6a5 100644
--- a/app/Template/app/filters_helper.php
+++ b/app/Template/app/filters_helper.php
@@ -12,8 +12,7 @@
         <li><a href="#" class="filter-helper" data-filter="status:open assignee:nobody"><?= t('Not assigned') ?></a></li>
         <li><a href="#" class="filter-helper" data-filter="status:open category:none"><?= t('No category') ?></a></li>
         <li>
-            <i class="fa fa-external-link"></i>
-            <a href="http://kanboard.net/documentation/search" target="_blank"><?= t('View advanced search syntax') ?></a>
+            <?= $this->url->doc(t('View advanced search syntax'), 'search') ?>
         </li>
     </ul>
 </div>
\ No newline at end of file
diff --git a/app/Template/category/edit.php b/app/Template/category/edit.php
index f844eea4..1aae2f2a 100644
--- a/app/Template/category/edit.php
+++ b/app/Template/category/edit.php
@@ -30,7 +30,7 @@
             </li>
         </ul>
     </div>
-    <div class="form-help"><a href="http://kanboard.net/documentation/syntax-guide" target="_blank" rel="noreferrer"><?= t('Write your text in Markdown') ?></a></div>
+    <div class="form-help"><?= $this->url->doc(t('Write your text in Markdown'), 'syntax-guide') ?></div>
 
     <div class="form-actions">
         <input type="submit" value="<?= t('Save') ?>" class="btn btn-blue"/>
diff --git a/app/Template/column/edit.php b/app/Template/column/edit.php
index 691cff00..a17affd8 100644
--- a/app/Template/column/edit.php
+++ b/app/Template/column/edit.php
@@ -34,7 +34,7 @@
             </li>
         </ul>
     </div>
-    <div class="form-help"><a href="http://kanboard.net/documentation/syntax-guide" target="_blank" rel="noreferrer"><?= t('Write your text in Markdown') ?></a></div>
+    <div class="form-help"><?= $this->url->doc(t('Write your text in Markdown'), 'syntax-guide') ?></div>
 
     <div class="form-actions">
         <input type="submit" value="<?= t('Save') ?>" class="btn btn-blue"/>
diff --git a/app/Template/column/index.php b/app/Template/column/index.php
index a394ee67..689cbbf5 100644
--- a/app/Template/column/index.php
+++ b/app/Template/column/index.php
@@ -81,7 +81,7 @@
             </li>
         </ul>
     </div>
-    <div class="form-help"><a href="http://kanboard.net/documentation/syntax-guide" target="_blank" rel="noreferrer"><?= t('Write your text in Markdown') ?></a></div>
+    <div class="form-help"><?= $this->url->doc(t('Write your text in Markdown'), 'syntax-guide') ?></div>
 
     <div class="form-actions">
         <input type="submit" value="<?= t('Add this column') ?>" class="btn btn-blue"/>
diff --git a/app/Template/comment/create.php b/app/Template/comment/create.php
index 8c66d9a4..8bcbe0f7 100644
--- a/app/Template/comment/create.php
+++ b/app/Template/comment/create.php
@@ -24,7 +24,7 @@
         </div>
     </div>
 
-    <div class="form-help"><a href="http://kanboard.net/documentation/syntax-guide" target="_blank" rel="noreferrer"><?= t('Write your text in Markdown') ?></a></div>
+    <div class="form-help"><?= $this->url->doc(t('Write your text in Markdown'), 'syntax-guide') ?></div>
 
     <div class="form-actions">
         <input type="submit" value="<?= t('Save') ?>" class="btn btn-blue"/>
diff --git a/app/Template/comment/edit.php b/app/Template/comment/edit.php
index d67aa387..e01f3da4 100644
--- a/app/Template/comment/edit.php
+++ b/app/Template/comment/edit.php
@@ -26,7 +26,7 @@
         </div>
     </div>
 
-    <div class="form-help"><a href="http://kanboard.net/documentation/syntax-guide" target="_blank" rel="noreferrer"><?= t('Write your text in Markdown') ?></a></div>
+    <div class="form-help"><?= $this->url->doc(t('Write your text in Markdown'), 'syntax-guide') ?></div>
 
     <div class="form-actions">
         <input type="submit" value="<?= t('Update') ?>" class="btn btn-blue"/>
diff --git a/app/Template/config/integrations.php b/app/Template/config/integrations.php
index ddbd73dd..4e24a270 100644
--- a/app/Template/config/integrations.php
+++ b/app/Template/config/integrations.php
@@ -9,37 +9,37 @@
     <h3><i class="fa fa-google"></i> <?= t('Google Authentication') ?></h3>
     <div class="listing">
     <input type="text" class="auto-select" readonly="readonly" value="<?= $this->url->href('oauth', 'google', array(), false, '', true) ?>"/><br/>
-    <p class="form-help"><a href="http://kanboard.net/documentation/google-authentication" target="_blank"><?= t('Help on Google authentication') ?></a></p>
+    <p class="form-help"><?= $this->url->doc(t('Help on Google authentication'), 'google-authentication') ?></p>
     </div>
 
     <h3><i class="fa fa-github"></i> <?= t('Github Authentication') ?></h3>
     <div class="listing">
     <input type="text" class="auto-select" readonly="readonly" value="<?= $this->url->href('oauth', 'github', array(), false, '', true) ?>"/><br/>
-    <p class="form-help"><a href="http://kanboard.net/documentation/github-authentication" target="_blank"><?= t('Help on Github authentication') ?></a></p>
+    <p class="form-help"><?= $this->url->doc(t('Help on Github authentication'), 'github-authentication') ?></p>
     </div>
 
     <h3><img src="<?= $this->url->dir() ?>assets/img/gitlab-icon.png"/>&nbsp;<?= t('Gitlab Authentication') ?></h3>
     <div class="listing">
     <input type="text" class="auto-select" readonly="readonly" value="<?= $this->url->href('oauth', 'gitlab', array(), false, '', true) ?>"/><br/>
-    <p class="form-help"><a href="http://kanboard.net/documentation/gitlab-authentication" target="_blank"><?= t('Help on Gitlab authentication') ?></a></p>
+    <p class="form-help"><?= $this->url->doc(t('Help on Gitlab authentication'), 'gitlab-authentication') ?></p>
     </div>
 
     <h3><img src="<?= $this->url->dir() ?>assets/img/mailgun-icon.png"/>&nbsp;<?= t('Mailgun (incoming emails)') ?></h3>
     <div class="listing">
     <input type="text" class="auto-select" readonly="readonly" value="<?= $this->url->href('webhook', 'mailgun', array('token' => $values['webhook_token']), false, '', true) ?>"/><br/>
-    <p class="form-help"><a href="http://kanboard.net/documentation/mailgun" target="_blank"><?= t('Help on Mailgun integration') ?></a></p>
+    <p class="form-help"><?= $this->url->doc(t('Help on Mailgun integration'), 'mailgun') ?></p>
     </div>
 
     <h3><img src="<?= $this->url->dir() ?>assets/img/sendgrid-icon.png"/>&nbsp;<?= t('Sendgrid (incoming emails)') ?></h3>
     <div class="listing">
     <input type="text" class="auto-select" readonly="readonly" value="<?= $this->url->href('webhook', 'sendgrid', array('token' => $values['webhook_token']), false, '', true) ?>"/><br/>
-    <p class="form-help"><a href="http://kanboard.net/documentation/sendgrid" target="_blank"><?= t('Help on Sendgrid integration') ?></a></p>
+    <p class="form-help"><?= $this->url->doc(t('Help on Sendgrid integration'), 'sendgrid') ?></p>
     </div>
 
     <h3><img src="<?= $this->url->dir() ?>assets/img/postmark-icon.png"/>&nbsp;<?= t('Postmark (incoming emails)') ?></h3>
     <div class="listing">
     <input type="text" class="auto-select" readonly="readonly" value="<?= $this->url->href('webhook', 'postmark', array('token' => $values['webhook_token']), false, '', true) ?>"/><br/>
-    <p class="form-help"><a href="http://kanboard.net/documentation/postmark" target="_blank"><?= t('Help on Postmark integration') ?></a></p>
+    <p class="form-help"><?= $this->url->doc(t('Help on Postmark integration'), 'postmark') ?></p>
     </div>
 
     <h3><img src="<?= $this->url->dir() ?>assets/img/gravatar-icon.png"/>&nbsp;<?= t('Gravatar') ?></h3>
@@ -70,7 +70,7 @@
         <?= $this->form->label(t('Multi-user chat room'), 'integration_jabber_room') ?>
         <?= $this->form->text('integration_jabber_room', $values, $errors, array('placeholder="myroom@conference.example.com"')) ?>
 
-        <p class="form-help"><a href="http://kanboard.net/documentation/jabber" target="_blank"><?= t('Help on Jabber integration') ?></a></p>
+        <p class="form-help"><?= $this->url->doc(t('Help on Jabber integration'), 'jabber') ?></p>
     </div>
 
     <h3><img src="<?= $this->url->dir() ?>assets/img/hipchat-icon.png"/> <?= t('Hipchat') ?></h3>
@@ -86,7 +86,7 @@
         <?= $this->form->label(t('Room notification token'), 'integration_hipchat_room_token') ?>
         <?= $this->form->text('integration_hipchat_room_token', $values, $errors) ?>
 
-        <p class="form-help"><a href="http://kanboard.net/documentation/hipchat" target="_blank"><?= t('Help on Hipchat integration') ?></a></p>
+        <p class="form-help"><?= $this->url->doc(t('Help on Hipchat integration'), 'hipchat') ?></p>
     </div>
 
     <h3><i class="fa fa-slack fa-fw"></i>&nbsp;<?= t('Slack') ?></h3>
@@ -98,7 +98,7 @@
         <?= $this->form->label(t('Channel/Group/User (Optional)'), 'integration_slack_webhook_channel') ?>
         <?= $this->form->text('integration_slack_webhook_channel', $values, $errors) ?>
 
-        <p class="form-help"><a href="http://kanboard.net/documentation/slack" target="_blank"><?= t('Help on Slack integration') ?></a></p>
+        <p class="form-help"><?= $this->url->doc(t('Help on Slack integration'), 'slack') ?></p>
     </div>
 
     <div class="form-actions">
diff --git a/app/Template/config/sidebar.php b/app/Template/config/sidebar.php
index b2c73292..3617979a 100644
--- a/app/Template/config/sidebar.php
+++ b/app/Template/config/sidebar.php
@@ -31,6 +31,9 @@
         <li <?= $this->app->getRouterAction() === 'api' ? 'class="active"' : '' ?>>
             <?= $this->url->link(t('API'), 'config', 'api') ?>
         </li>
+        <li>
+            <?= $this->url->link(t('Documentation'), 'doc', 'show') ?>
+        </li>
     </ul>
     <div class="sidebar-collapse"><a href="#" title="<?= t('Hide sidebar') ?>"><i class="fa fa-chevron-left"></i></a></div>
     <div class="sidebar-expand" style="display: none"><a href="#" title="<?= t('Expand sidebar') ?>"><i class="fa fa-chevron-right"></i></a></div>
diff --git a/app/Template/doc/show.php b/app/Template/doc/show.php
new file mode 100644
index 00000000..8fbadc93
--- /dev/null
+++ b/app/Template/doc/show.php
@@ -0,0 +1,13 @@
+<section id="main">
+    <div class="page-header">
+        <ul>
+            <li>
+                <i class="fa fa-life-ring fa-fw"></i>
+                <?= $this->url->link(t('Table of contents'), 'doc', 'show', array('file' => 'index')) ?>
+            </li>
+        </ul>
+    </div>
+    <div class="markdown documentation">
+        <?= $content ?>
+    </div>
+</section>
\ No newline at end of file
diff --git a/app/Template/project/edit.php b/app/Template/project/edit.php
index 3c64a399..8dcbb88f 100644
--- a/app/Template/project/edit.php
+++ b/app/Template/project/edit.php
@@ -42,7 +42,7 @@
             </li>
         </ul>
     </div>
-    <div class="form-help"><a href="http://kanboard.net/documentation/syntax-guide" target="_blank" rel="noreferrer"><?= t('Write your text in Markdown') ?></a></div>
+    <div class="form-help"><?= $this->url->doc(t('Write your text in Markdown'), 'syntax-guide') ?></div>
 
     <div class="form-actions">
         <input type="submit" value="<?= t('Save') ?>" class="btn btn-blue"/>
diff --git a/app/Template/project/integrations.php b/app/Template/project/integrations.php
index 12a7ee4e..eb5faddf 100644
--- a/app/Template/project/integrations.php
+++ b/app/Template/project/integrations.php
@@ -9,21 +9,21 @@
     <h3><i class="fa fa-github fa-fw"></i>&nbsp;<?= t('Github webhooks') ?></h3>
     <div class="listing">
     <input type="text" class="auto-select" readonly="readonly" value="<?= $this->url->href('webhook', 'github', array('token' => $webhook_token, 'project_id' => $project['id']), false, '', true) ?>"/><br/>
-    <p class="form-help"><a href="http://kanboard.net/documentation/github-webhooks" target="_blank"><?= t('Help on Github webhooks') ?></a></p>
+    <p class="form-help"><?= $this->url->doc(t('Help on Github webhooks'), 'github-webhooks') ?></p>
     </div>
 
 
     <h3><img src="<?= $this->url->dir() ?>assets/img/gitlab-icon.png"/>&nbsp;<?= t('Gitlab webhooks') ?></h3>
     <div class="listing">
     <input type="text" class="auto-select" readonly="readonly" value="<?= $this->url->href('webhook', 'gitlab', array('token' => $webhook_token, 'project_id' => $project['id']), false, '', true) ?>"/><br/>
-    <p class="form-help"><a href="http://kanboard.net/documentation/gitlab-webhooks" target="_blank"><?= t('Help on Gitlab webhooks') ?></a></p>
+    <p class="form-help"><?= $this->url->doc(t('Help on Gitlab webhooks'), 'gitlab-webhooks') ?></p>
     </div>
 
 
     <h3><i class="fa fa-bitbucket fa-fw"></i>&nbsp;<?= t('Bitbucket webhooks') ?></h3>
     <div class="listing">
     <input type="text" class="auto-select" readonly="readonly" value="<?= $this->url->href('webhook', 'bitbucket', array('token' => $webhook_token, 'project_id' => $project['id']), false, '', true) ?>"/><br/>
-    <p class="form-help"><a href="http://kanboard.net/documentation/bitbucket-webhooks" target="_blank"><?= t('Help on Bitbucket webhooks') ?></a></p>
+    <p class="form-help"><?= $this->url->doc(t('Help on Bitbucket webhooks'), 'bitbucket-webhooks') ?></p>
     </div>
 
 
@@ -50,7 +50,7 @@
         <?= $this->form->label(t('Multi-user chat room'), 'jabber_room') ?>
         <?= $this->form->text('jabber_room', $values, $errors, array('placeholder="myroom@conference.example.com"')) ?>
 
-        <p class="form-help"><a href="http://kanboard.net/documentation/jabber" target="_blank"><?= t('Help on Jabber integration') ?></a></p>
+        <p class="form-help"><?= $this->url->doc(t('Help on Jabber integration'), 'jabber') ?></p>
 
         <div class="form-actions">
             <input type="submit" value="<?= t('Save') ?>" class="btn btn-blue"/>
@@ -71,7 +71,7 @@
         <?= $this->form->label(t('Room notification token'), 'hipchat_room_token') ?>
         <?= $this->form->text('hipchat_room_token', $values, $errors) ?>
 
-        <p class="form-help"><a href="http://kanboard.net/documentation/hipchat" target="_blank"><?= t('Help on Hipchat integration') ?></a></p>
+        <p class="form-help"><?= $this->url->doc(t('Help on Hipchat integration'), 'hipchat') ?></a></p>
 
         <div class="form-actions">
             <input type="submit" value="<?= t('Save') ?>" class="btn btn-blue"/>
@@ -88,7 +88,7 @@
         <?= $this->form->label(t('Channel/Group/User (Optional)'), 'slack_webhook_channel') ?>
         <?= $this->form->text('slack_webhook_channel', $values, $errors) ?>
 
-        <p class="form-help"><a href="http://kanboard.net/documentation/slack" target="_blank"><?= t('Help on Slack integration') ?></a></p>
+        <p class="form-help"><?= $this->url->doc(t('Help on Slack integration'), 'slack') ?></p>
 
         <div class="form-actions">
             <input type="submit" value="<?= t('Save') ?>" class="btn btn-blue"/>
diff --git a/app/Template/project/users.php b/app/Template/project/users.php
index d725a9e8..8863a1e4 100644
--- a/app/Template/project/users.php
+++ b/app/Template/project/users.php
@@ -77,5 +77,6 @@
     <ul>
         <li><?= t('A project manager can change the settings of the project and have more privileges than a standard user.') ?></li>
         <li><?= t('Don\'t forget that administrators have access to everything.') ?></li>
+        <li><?= $this->url->doc(t('Help with project permissions'), 'project-permissions') ?></li>
     </ul>
 </div>
diff --git a/app/Template/search/index.php b/app/Template/search/index.php
index 8940a24e..329c072a 100644
--- a/app/Template/search/index.php
+++ b/app/Template/search/index.php
@@ -31,7 +31,7 @@
                 <li><?= t('Search by description: ') ?><strong>description:"Something to find"</strong></li>
                 <li><?= t('Search by due date: ') ?><strong>due:2015-07-01</strong></li>
             </ul>
-            <p><i class="fa fa-external-link fa-fw"></i><a href="http://kanboard.net/documentation/search" target="_blank"><?= t('View advanced search syntax') ?></a></p>
+            <p><i class="fa fa-external-link fa-fw"></i><?= $this->url->doc(t('View advanced search syntax'), 'search') ?></p>
         </div>
     <?php elseif (! empty($values['search']) && $paginator->isEmpty()): ?>
         <p class="alert"><?= t('Nothing found.') ?></p>
diff --git a/app/Template/task_creation/form.php b/app/Template/task_creation/form.php
index 84f28a1e..8a29896e 100644
--- a/app/Template/task_creation/form.php
+++ b/app/Template/task_creation/form.php
@@ -38,7 +38,7 @@
             </ul>
         </div>
 
-        <div class="form-help"><a href="http://kanboard.net/documentation/syntax-guide" target="_blank" rel="noreferrer"><?= t('Write your text in Markdown') ?></a></div>
+        <div class="form-help"><?= $this->url->doc(t('Write your text in Markdown'), 'syntax-guide') ?></div>
 
         <?php if (! isset($duplicate)): ?>
             <?= $this->form->checkbox('another_task', t('Create another task'), 1, isset($values['another_task']) && $values['another_task'] == 1) ?>
diff --git a/app/Template/task_modification/edit_description.php b/app/Template/task_modification/edit_description.php
index 3168f7a3..4cae939c 100644
--- a/app/Template/task_modification/edit_description.php
+++ b/app/Template/task_modification/edit_description.php
@@ -24,7 +24,7 @@
         </div>
     </div>
 
-    <div class="form-help"><a href="http://kanboard.net/documentation/syntax-guide" target="_blank" rel="noreferrer"><?= t('Write your text in Markdown') ?></a></div>
+    <div class="form-help"><?= $this->url->doc(t('Write your text in Markdown'), 'syntax-guide') ?></div>
 
     <div class="form-actions">
         <input type="submit" value="<?= t('Save') ?>" class="btn btn-blue"/>
-- 
cgit v1.2.3