<?php
-
/**
* Documentation action.
*
* @link http://status.net/
*
* StatusNet - the distributed open-source microblogging tool
- * Copyright (C) 2008, 2009, StatusNet, Inc.
+ * Copyright (C) 2008-2010, StatusNet, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
*
* @return void
*/
-
function showPageTitle()
{
$this->element('h1', array('class' => 'entry-title'), $this->title());
*
* @return void.
*/
-
function showContentBlock()
{
$this->elementStart('div', array('id' => 'content', 'class' => 'hentry'));
*
* @return void
*/
-
function showContent()
{
$this->raw($this->output);
*
* @return boolean read-only flag (false)
*/
-
function isReadOnly($args)
{
return true;
{
if (Event::handle('StartLoadDoc', array(&$this->title, &$this->output))) {
- $this->filename = $this->getFilename();
+ $paths = DocFile::defaultPaths();
- if (empty($this->filename)) {
- throw new ClientException(sprintf(_('No such document "%s"'), $this->title), 404);
- }
+ $docfile = DocFile::forTitle($this->title, $paths);
- $c = file_get_contents($this->filename);
+ if (empty($docfile)) {
+ // TRANS: Client exception thrown when requesting a document from the documentation that does not exist.
+ // TRANS: %s is the non-existing document.
+ throw new ClientException(sprintf(_('No such document "%s".'), $this->title), 404);
+ }
- $this->output = common_markup_to_html($c);
+ $this->output = $docfile->toHTML();
Event::handle('EndLoadDoc', array($this->title, &$this->output));
}
}
- function getFilename()
+ function showLocalNav()
{
- if (file_exists(INSTALLDIR.'/local/doc-src/'.$this->title)) {
- $localDef = INSTALLDIR.'/local/doc-src/'.$this->title;
- }
-
- $local = glob(INSTALLDIR.'/local/doc-src/'.$this->title.'.*');
-
- if (count($local) || isset($localDef)) {
- return $this->negotiateLanguage($local, $localDef);
- }
-
- if (file_exists(INSTALLDIR.'/doc-src/'.$this->title)) {
- $distDef = INSTALLDIR.'/doc-src/'.$this->title;
- }
-
- $dist = glob(INSTALLDIR.'/doc-src/'.$this->title.'.*');
-
- if (count($dist) || isset($distDef)) {
- return $this->negotiateLanguage($dist, $distDef);
- }
-
- return null;
+ $menu = new DocNav($this);
+ $menu->show();
}
+}
- function negotiateLanguage($filenames, $defaultFilename=null)
+class DocNav extends Menu
+{
+ function show()
{
- // XXX: do this better
+ $stub = new HomeStubNav($this->action);
+ $this->submenu(_m('MENU','Home'), $stub);
- $langcode = common_language();
+ $docs = new DocListNav($this->action);
+ $this->submenu(_m('MENU','Docs'), $docs);
+ }
+}
- foreach ($filenames as $filename) {
- if (preg_match('/\.'.$langcode.'$/', $filename)) {
- return $filename;
- }
+class DocListNav extends Menu
+{
+ function getItems()
+ {
+ $items = array();
+
+ if (Event::handle('StartDocsMenu', array(&$items))) {
+
+ $items = array(array('doc',
+ array('title' => 'help'),
+ _m('MENU', 'Help'),
+ _('Getting started'),
+ 'nav_doc_help'),
+ array('doc',
+ array('title' => 'about'),
+ _m('MENU', 'About'),
+ _('About this site'),
+ 'nav_doc_about'),
+ array('doc',
+ array('title' => 'faq'),
+ _m('MENU', 'FAQ'),
+ _('Frequently asked questions'),
+ 'nav_doc_faq'),
+ array('doc',
+ array('title' => 'contact'),
+ _m('MENU', 'Contact'),
+ _('Contact info'),
+ 'nav_doc_contact'),
+ array('doc',
+ array('title' => 'tags'),
+ _m('MENU', 'Tags'),
+ _('Using tags'),
+ 'nav_doc_tags'),
+ array('doc',
+ array('title' => 'groups'),
+ _m('MENU', 'Groups'),
+ _('Using groups'),
+ 'nav_doc_groups'),
+ array('doc',
+ array('title' => 'api'),
+ _m('MENU', 'API'),
+ _('RESTful API'),
+ 'nav_doc_api'));
+
+ Event::handle('EndDocsMenu', array(&$items));
}
-
- return $defaultFilename;
+ return $items;
}
}