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

MINOR: changed path for docs from docs to doc

Browse Source
This commit is contained in:
Will Rossiter 2010-03-04 08:54:17 +00:00
parent ae6e8ee3d4
commit ee8eb4e7b5
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
code/DocumentationViewer.php
View File

@ -62,7 +62,7 @@ class DocumentationViewer extends Controller {
// see if docs folder is present // see if docs folder is present
$subfolders = scandir(BASE_PATH .'/'. $module); $subfolders = scandir(BASE_PATH .'/'. $module);
if($subfolders && in_array('docs', $subfolders)) { if($subfolders && in_array('doc', $subfolders)) {
$this->generateNestedTree($module); $this->generateNestedTree($module);
} }
else { else {
@ -121,7 +121,7 @@ class DocumentationViewer extends Controller {
$base = Director::baseURL(); $base = Director::baseURL();
// find page // find page
$path = BASE_PATH . '/'. $module .'/docs/'; $path = BASE_PATH . '/'. $module .'/doc/';
echo "<div id='LeftColumn'><div class='box'>"; echo "<div id='LeftColumn'><div class='box'>";
if($page = $this->findPage($path, $class)) { if($page = $this->findPage($path, $class)) {
@ -179,7 +179,7 @@ class DocumentationViewer extends Controller {
* @param String - module to generate * @param String - module to generate
*/ */
private function generateNestedTree($module) { private function generateNestedTree($module) {
$path = BASE_PATH . '/'. $module .'/docs/'; $path = BASE_PATH . '/'. $module .'/doc/';
return (is_dir($path)) ? $this->recursivelyGenerateTree($path, $module) : false; return (is_dir($path)) ? $this->recursivelyGenerateTree($path, $module) : false;
} }

4
docs/Writing-Documentation.md
View File

@ -2,13 +2,13 @@
Your documentation needs to go in the specific modules doc folder which it refers mostly too. For example if you want to document Your documentation needs to go in the specific modules doc folder which it refers mostly too. For example if you want to document
a feature of your custom module 'MyModule' you need to create markdown files in mymodule/docs/. a feature of your custom module 'MyModule' you need to create markdown files in mymodule/doc/.
The files have to end with the __.md__ extension. The documentation viewer will automatically replace hyphens (-) with spaces (since you cannot The files have to end with the __.md__ extension. The documentation viewer will automatically replace hyphens (-) with spaces (since you cannot
have spaces easily in some file systems). have spaces easily in some file systems).
## Syntax ## ## Syntax ##
This uses a customized markdown extra parser. To view the syntax for page formatting check out [http://daringfireball.net/projects/markdown/syntax](Daring Fireball) This uses a customized markdown extra parser. To view the syntax for page formatting check out [http://daringfireball.net/projects/markdown/syntax][Daring Fireball]
## Creating Hierarchy ## ## Creating Hierarchy ##