diff options
Diffstat (limited to 'include')
-rw-r--r-- | include/help.php | 197 |
1 files changed, 0 insertions, 197 deletions
diff --git a/include/help.php b/include/help.php index 9e4be57f9..12721a30b 100644 --- a/include/help.php +++ b/include/help.php @@ -5,203 +5,6 @@ use CommerceGuys\Intl\Language\LanguageRepository; require_once('include/items.php'); -/** - * @brief - * - * @param string $path - * @param string $suffix (optional) default null - * @return string - */ -function get_help_fullpath($path, $suffix = null) { - - $docroot = (\App::$override_helproot) ? \App::$override_helproot : 'doc/'; - $docroot = (substr($docroot,-1)!='/') ? $docroot .= '/' : $docroot; - - // Determine the language and modify the path accordingly - $x = determine_help_language(); - $lang = $x['language']; - - // The English translation is at the root of /doc/. Other languages are in - // subfolders named by the language code such as "de", "es", etc. - if($lang !== 'en') { - $langpath = $lang . '/' . $path; - } else { - $langpath = $path; - } - - $newpath = (isset(\App::$override_helpfiles[$langpath])) ? \App::$override_helpfiles[$langpath] : $langpath; - $newpath = ($newpath == $langpath) ? $docroot . $newpath : $newpath; - - if ($suffix) { - if (file_exists($newpath . $suffix)) { - return $newpath; - } - } elseif (file_exists($newpath . '.md') || - file_exists($newpath . '.bb') || - file_exists($newpath . '.html')) { - return $newpath; - } - - $newpath = (isset(\App::$override_helpfiles[$path])) ? \App::$override_helpfiles[$path] : null; - - $newpath = (!$newpath) ? $docroot.$path : $newpath; - return $newpath; -} - - -/** - * @brief - * - * @param string $tocpath (optional) default false - * @return string - */ -function get_help_content($tocpath = false) { - - $doctype = 'markdown'; - - $text = ''; - - $path = (($tocpath !== false) ? $tocpath : ''); - $docroot = (\App::$override_helproot) ? \App::$override_helproot : 'doc/'; - $docroot = (substr($docroot,-1)!='/') ? $docroot .= '/' : $docroot; - - if($tocpath === false && argc() > 1) { - $path = ''; - for($x = 1; $x < argc(); $x ++) { - if(strlen($path)) - $path .= '/'; - $path .= argv($x); - } - } - - - if($path) { - $fullpath = get_help_fullpath($path); - $title = basename($path); - if(! $tocpath) - \App::$page['title'] = t('Help:') . ' ' . ucwords(str_replace('-',' ',notags($title))); - - // Check that there is a "toc" or "sitetoc" located at the specified path. - // If there is not, then there was not a translation of the table of contents - // available and so default back to the English TOC at /doc/toc.{html,bb,md} - // TODO: This is incompatible with the hierarchical TOC construction - // defined in /Zotlabs/Widget/Helpindex.php. - if($tocpath !== false && - load_doc_file($fullpath . '.md') === '' && - load_doc_file($fullpath . '.bb') === '' && - load_doc_file($fullpath . '.html') === '' - ) { - $path = $title; - } - $fullpath = get_help_fullpath($path); - $text = load_doc_file($fullpath . '.md'); - - if(! $text) { - $text = load_doc_file($fullpath . '.bb'); - if($text) - $doctype = 'bbcode'; - } - if(! $text) { - $text = load_doc_file($fullpath . '.html'); - if($text) - $doctype = 'html'; - } - } - - if(($tocpath) && (! $text)) - return ''; - - if($tocpath === false) { - if(! $text) { - $path = 'Site'; - $fullpath = get_help_fullpath($path,'.md'); - $text = load_doc_file($fullpath . '.md'); - \App::$page['title'] = t('Help'); - } - if(! $text) { - $doctype = 'bbcode'; - $path = 'main'; - $fullpath = get_help_fullpath($path,'.md'); - $text = load_doc_file($fullpath . '.bb'); - goaway('/help/about/about'); - \App::$page['title'] = t('Help'); - } - - if(! $text) { - header($_SERVER["SERVER_PROTOCOL"] . ' 404 ' . t('Not Found')); - $tpl = get_markup_template("404.tpl"); - return replace_macros($tpl, array( - '$message' => t('Page not found.') - )); - } - } - - if($doctype === 'html') - $content = parseIdentityAwareHTML($text); - if($doctype === 'markdown') { - # escape #include tags - $text = preg_replace('/#include/ism', '%%include', $text); - $content = MarkdownExtra::defaultTransform($text); - $content = preg_replace('/%%include/ism', '#include', $content); - } - if($doctype === 'bbcode') { - require_once('include/bbcode.php'); - $content = zidify_links(bbcode($text)); - // bbcode retargets external content to new windows. This content is internal. - $content = str_replace(' target="_blank"', '', $content); - } - - $content = preg_replace_callback("/#include (.*?)\;/ism", 'preg_callback_help_include', $content); - - return translate_projectname($content); -} - -function preg_callback_help_include($matches) { - - if($matches[1]) { - $include = str_replace($matches[0],load_doc_file($matches[1]),$matches[0]); - if(preg_match('/\.bb$/', $matches[1]) || preg_match('/\.txt$/', $matches[1])) { - require_once('include/bbcode.php'); - $include = zidify_links(bbcode($include)); - $include = str_replace(' target="_blank"','',$include); - } - elseif(preg_match('/\.md$/', $matches[1])) { - $include = MarkdownExtra::defaultTransform($include); - } - return $include; - } - -} - -/** - * @brief Determines help language. - * - * If the language was specified in the URL, override the language preference - * of the browser. Default to English if both of these are absent. - * - * @return array Associative array with: - * * \e string \b language - 2-letter ISO 639-1 code ("en") - * * \e boolean \b from_url - true if language from URL overrides browser default - */ -function determine_help_language() { - - $language_repository = new LanguageRepository; - $languages = $language_repository->getList(); - - if(array_key_exists(argv(1), $languages)) { - $lang = argv(1); - $from_url = true; - } else { - $lang = \App::$language; - if(! isset($lang)) - $lang = 'en'; - - $from_url = false; - } - - return array('language' => $lang, 'from_url' => $from_url); -} - function load_doc_file($s) { $c = find_doc_file($s); |