friendica/mod/help.php

116 lines
2.5 KiB
PHP
Raw Normal View History

2011-04-13 10:07:21 -04:00
<?php
/**
* @file mod/help.php
*/
2018-07-09 21:53:19 -04:00
use Friendica\App;
use Friendica\Content\Nav;
2018-01-14 18:59:08 -05:00
use Friendica\Content\Text\Markdown;
use Friendica\Core\Config;
2018-01-22 07:29:50 -05:00
use Friendica\Core\L10n;
use Friendica\Core\Renderer;
2017-08-26 02:04:21 -04:00
use Friendica\Core\System;
use Friendica\Util\Strings;
2018-07-09 21:53:19 -04:00
function load_doc_file($s)
{
$lang = Config::get('system', 'language');
2018-07-09 21:53:19 -04:00
$b = basename($s);
$d = dirname($s);
if (file_exists("$d/$lang/$b")) {
return file_get_contents("$d/$lang/$b");
}
2018-07-09 21:53:19 -04:00
if (file_exists($s)) {
return file_get_contents($s);
}
2011-04-13 10:07:21 -04:00
2018-07-09 21:53:19 -04:00
return '';
}
2018-07-09 21:53:19 -04:00
function help_content(App $a)
{
Nav::setSelected('help');
2011-04-13 10:07:21 -04:00
$text = '';
$filename = '';
2011-04-13 10:07:21 -04:00
if ($a->argc > 1) {
2015-12-26 10:06:38 -05:00
$path = '';
2015-12-27 21:17:55 -05:00
// looping through the argv keys bigger than 0 to build
// a path relative to /help
for ($x = 1; $x < $a->argc; $x ++) {
2018-07-09 21:53:19 -04:00
if (strlen($path)) {
2015-12-26 10:06:38 -05:00
$path .= '/';
2018-07-09 21:53:19 -04:00
}
$path .= $a->getArgumentValue($x);
2015-12-26 10:06:38 -05:00
}
$title = basename($path);
$filename = $path;
2015-12-26 10:06:38 -05:00
$text = load_doc_file('doc/' . $path . '.md');
$a->page['title'] = L10n::t('Help:') . ' ' . str_replace('-', ' ', Strings::escapeTags($title));
2011-04-14 05:34:43 -04:00
}
2018-07-09 21:53:19 -04:00
$home = load_doc_file('doc/Home.md');
if (!$text) {
$text = $home;
$filename = "Home";
2018-01-22 07:29:50 -05:00
$a->page['title'] = L10n::t('Help');
} else {
2018-01-14 18:59:08 -05:00
$a->page['aside'] = Markdown::convert($home, false);
2011-04-13 10:07:21 -04:00
}
if (!strlen($text)) {
throw new \Friendica\Network\HTTPException\NotFoundException();
}
2018-01-14 18:59:08 -05:00
$html = Markdown::convert($text, false);
2015-12-28 04:21:34 -05:00
if ($filename !== "Home") {
// create TOC but not for home
$lines = explode("\n", $html);
2018-07-09 21:53:19 -04:00
$toc = "<h2>TOC</h2><ul id='toc'>";
$lastlevel = 1;
$idnum = [0, 0, 0, 0, 0, 0, 0];
foreach ($lines as &$line) {
if (substr($line, 0, 2) == "<h") {
$level = substr($line, 2, 1);
if ($level != "r") {
2015-12-28 04:21:34 -05:00
$level = intval($level);
2018-07-09 21:53:19 -04:00
if ($level < $lastlevel) {
for ($k = $level; $k < $lastlevel; $k++) {
2019-01-29 08:51:02 -05:00
$toc .= "</ul></li>";
2018-07-09 21:53:19 -04:00
}
for ($k = $level + 1; $k < count($idnum); $k++) {
$idnum[$k] = 0;
}
}
if ($level > $lastlevel) {
2019-01-29 08:51:02 -05:00
$toc .= "<li><ul>";
2015-12-28 04:21:34 -05:00
}
2018-07-09 21:53:19 -04:00
$idnum[$level] ++;
$id = implode("_", array_slice($idnum, 1, $level));
$href = System::baseUrl() . "/help/{$filename}#{$id}";
$toc .= "<li><a href='{$href}'>" . strip_tags($line) . "</a></li>";
$line = "<a name='{$id}'></a>" . $line;
2015-12-28 04:21:34 -05:00
$lastlevel = $level;
}
}
}
2018-07-09 21:53:19 -04:00
for ($k = 0; $k < $lastlevel; $k++) {
$toc .= "</ul>";
}
$html = implode("\n", $lines);
2018-04-25 17:30:56 -04:00
$a->page['aside'] = '<div class="help-aside-wrapper widget"><div id="toc-wrapper">' . $toc . '</div>' . $a->page['aside'] . '</div>';
2015-12-28 04:21:34 -05:00
}
return $html;
}