Revise readmes module configuration form

Author: Jamie Snape

modules/readmes/configs/module.ini

@@ -1,9 +1,8 @@
+; MIDAS Server. Copyright Kitware SAS. Licensed under the Apache License 2.0.
+
 [global]
-; version of the module
-version = 1.0.0
-; full name
-fullname = Readmes
-; description
-description = "Enables display of Readme files for Folders and Communities"
-; category
-category = Core
+fullname = "READMEs"
+description = "Display README files for communities and folders"
+category = "Core"
+uuid = "b53696e3-40f6-4a92-b96d-7bbce6562c57"
+version = "1.0.0"

modules/readmes/controllers/ConfigController.php renamed to modules/readmes/controllers/AdminController.php

@@ -18,27 +18,16 @@
  limitations under the License.
 =========================================================================*/
 
-/**
- * Readmes_ConfigController
- *
- * @category   Midas modules
- * @package    readmes
- */
-class Readmes_ConfigController extends Readmes_AppController
+/** Admin controller for the readmes module. */
+class Readmes_AdminController extends Readmes_AppController
 {
-    public $_components = array('Breadcrumb');
+    /** @var array */
+    public $_models = array('Setting');
 
-    /**
-     * @throws Zend_Exception on invalid userSession
-     */
+    /** Index action */
     public function indexAction()
     {
         $this->requireAdminPrivileges();
-
-        $iconPath = $this->view->moduleWebroot.'/public/images/page_white_text.png';
-        $breadcrumbs = array();
-        $breadcrumbs[] = array('type' => 'moduleList');
-        $breadcrumbs[] = array('type' => 'custom', 'text' => 'Readme Module Configuration', 'icon' => $iconPath);
-        $this->Component->Breadcrumb->setBreadcrumbHeader($breadcrumbs, $this->view);
+        $this->view->pageTitle = 'READMEs Module Configuration';
     }
 }

modules/readmes/views/config/index.phtml renamed to modules/readmes/views/admin/index.phtml

@@ -17,28 +17,21 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 =========================================================================*/
-?>
-<div class="viewMain">
-    <div class="genericWrapperTopRight">
-        <?php
-        echo '<div style="float:right;margin-right:2px;" class="genericBigButton ">';
-        echo "<a  href='{$this->webroot}/admin#tabs-modules'><img style='float:left;margin-right:2px;' alt='' src='{$this->coreWebroot}/public/images/icons/back.png'/>";
-        echo $this->t('Back');
-        echo "</a>";
-        echo '</div>';
-        ?>
-    </div>
-    <h3>Instructions for Use</h3>
-
-    <p>This module is intended to provide Readmes for communities as well as
-        folders. The text of these readmes will be interpreted from
-        <a href="https://daringfireball.net/projects/markdown/syntax">Markdown</a>
-        syntax and display in the info tab as well as below the hierarchical
-        data view.</p>
 
-    <p>For communities, place a file named readme, readme.txt, or readme.md
-        (case insensitive) at the root of the "Public" folder.</p>
+$this->declareVars('form', 'pageTitle');
+$this->headTitle($this->escape($this->pageTitle));
+?>
 
-    <p>For folders, place a similarly named file at the root of the folder in
-        question.</p>
+<div class="viewMain">
+    <h1><?php echo $this->escape($this->pageTitle); ?></h1>
+    <p>
+        This module renders README files for communities and folders. The text of these files will be interpreted as
+        <a href="https://daringfireball.net/projects/markdown/syntax">Markdown</a> syntax and displayed on the info tab
+        and below the hierarchical data view.
+    </p>
+    <p>
+        For communities, place a file named README, README.txt, or README.md (case insensitive) at the root of the
+        <i>Public</i> folder. For folders, place a similarly named file at the root of that folder.
+    </p>
+    <p><a href="<?php echo $this->url(array('controller' => 'admin', 'action' => 'index'), 'default'); ?>#tabs-modules">&laquo; Back to Modules Administration</a></p>
 </div>