tonyair/silverstripe-docsviewer
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-docsviewer synced 2024-10-22 11:05:56 +02:00
Code Issues Projects Releases Wiki Activity

ENHANCEMENT: fixed default homepage template to include links to individual modules rather than blank pages. BUGFIX: fixed doc viewer to not throw 404 error when no module provided

Browse Source
This commit is contained in:
Will Rossiter 2011-03-12 17:14:37 +13:00
parent 50de5f23ef
commit cfaa08d858
2 changed files with 31 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
code/DocumentationViewer.php
View File

@ -169,7 +169,7 @@ class DocumentationViewer extends Controller {
// 'current' version mapping
$module = DocumentationService::is_registered_module($this->module, null, $this->getLang());
if($module) {
$current = $module->getCurrentVersion();
@ -186,14 +186,14 @@ class DocumentationViewer extends Controller {
$this->redirect($link, 301); // permanent redirect
return $this->response;
}
}
// Check if page exists, otherwise return 404
if(!$this->locationExists()) {
$body = $this->renderWith(get_class($this));
$this->response = new SS_HTTPResponse($body, 404);
return $this->response;
}
// Check if page exists, otherwise return 404
if(!$this->locationExists()) {
$body = $this->renderWith(get_class($this));
$this->response = new SS_HTTPResponse($body, 404);
return $this->response;
}
}
return parent::handleRequest($request);
@ -357,6 +357,7 @@ class DocumentationViewer extends Controller {
$output->push(new ArrayData(array(
'Title' => $module->getTitle(),
'Code' => $module,
'Link' => $this->Link(array_slice($this->Remaining, -1, -1), $module->moduleFolder),
'Content' => DBField::create("HTMLText", $content)
)));
}
@ -387,6 +388,7 @@ class DocumentationViewer extends Controller {
*/
function locationExists() {
$module = $this->getModule();
return (
$module
&& (
@ -528,6 +530,7 @@ class DocumentationViewer extends Controller {
// In case no folder exists, show a "not found" page.
$module = $this->getModule();
$url = $this->Remaining;
if($url && $module) {
$pages = DocumentationService::get_pages_from_folder($module, implode('/', $url), false);
// If no pages are found, the 404 is handled in the same template
@ -536,6 +539,14 @@ class DocumentationViewer extends Controller {
'Pages' => $pages
))->renderWith('DocFolderListing');
}
else {
// get all available modules and show a table of contents.
return $this->customise(array(
'Title' => _t('DocumentationViewer.MODULES', 'Modules'),
'Pages' => $this->getModules()
))->renderWith('DocFolderListing');
}
}
return false;
@ -597,12 +608,12 @@ class DocumentationViewer extends Controller {
*
* @return String
*/
public function Link($path = false) {
public function Link($path = false, $module = false) {
$base = Director::absoluteBaseURL();
$version = ($this->version) ? $this->version . '/' : false;
$lang = ($this->language) ? $this->language .'/' : false;
$module = ($this->module) ? $this->module .'/' : false;
$module = (!$module && $this->module) ? $this->module .'/' : $module;
$action = '';

15
templates/Layout/DocumentationViewer_home.ss
View File

@ -1,10 +1,13 @@
<div id="home">
<% control Modules %>
<% if Content %>
<h2><% _t('DOCUMENTEDMODULES', 'Documented Modules') %></h2>
<% if Modules %>
<% control Modules %>
<div class="module">
$Content
<h3><a href="$Link">$Title</a></h3>
</div>
<% end_if %>
<% end_control %>
<% end_control %>
<% else %>
<p><% _t('NOMODULEDOCUMENTATION', 'No modules with documentation installed could be found.') %></p>
<% end_if %>
</div>