sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-25 05:22:59 +00:00
Code Activity

Add table of contents to help page

Browse source
This commit is contained in:
Starbeamrainbowlabs 2019-08-24 20:05:06 +01:00
parent da5b3a5df8
commit dc63d98925
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
3 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Changelog.md
View file

@ -7,6 +7,7 @@ This file holds the changelog for Pepperminty Wiki. This is the master list of t
### Fixed
- Fixed a bug in the search query performance metrics
- Fill out the statistics help text
- Added table of contents to help page
### Changed
- Made `build.sh` build script more robust, especially when generating the documentation.

4
module_index.json
View file

@ -135,7 +135,7 @@
"version": "0.10",
"author": "Starbeamrainbowlabs",
"description": "Adds proper search functionality to Pepperminty Wiki using an inverted index to provide a full text search engine. If pages don't show up, then you might have hit a stop word. If not, try requesting the `invindex-rebuild` action to rebuild the inverted index from scratch.",
"lastupdate": 1566672916,
"lastupdate": 1566672942,
"optional": false,
"extra_data": []
},
@ -237,7 +237,7 @@
"version": "0.9.4",
"author": "Starbeamrainbowlabs",
"description": "Adds a rather useful help page. Access through the 'help' action. This module also exposes help content added to Pepperminty Wiki's inbuilt invisible help section system.",
"lastupdate": 1566498566,
"lastupdate": 1566673434,
"optional": false,
"extra_data": []
},

19
modules/page-help.php
View file

@ -31,8 +31,7 @@ register_module([
// Sort the help sections by key
ksort($help_sections, SORT_NATURAL);
if(isset($_GET["dev"]) and $_GET["dev"] == "yes")
{
if(isset($_GET["dev"]) and $_GET["dev"] == "yes") {
$title = "Developers Help - $settings->sitename";
$content = "<p>$settings->sitename runs on Pepperminty Wiki, an entire wiki packed into a single file. This page contains some information that developers may find useful.</p>
<p>A full guide to developing a Pepperminty Wiki module can be found <a href='//github.com/sbrl/Pepperminty-Wiki/blob/master/Module_API_Docs.md#module-api-documentation'>on GitHub</a>.</p>
@ -117,21 +116,25 @@ register_module([
$content .= "<div class='stacked-bar-part' style='flex: $wikiSize->other; background: hsla(62, 55%, 90%, 0.6)'>Other: " . human_filesize($wikiSize->other) . "</div>\n";
$content .= "</div>";
}
else
{
else {
$title = "Help - $settings->sitename";
$content = " <h1>$settings->sitename Help</h1>
<p>Welcome to $settings->sitename!</p>
<p>$settings->sitename is powered by Pepperminty Wiki, a complete wiki in a box you can drop into your server and expect it to just <em>work</em>.</p>";
<p>$settings->sitename is powered by Pepperminty Wiki, a complete wiki in a box you can drop into your server and expect it to just <em>work</em>.</p>
<h2 id='contents' class='help-section-header'>Contents</h2>
<ol>";
foreach($help_sections as $index => $section)
$content .= "<li><a href='#{$index}'>{$section["title"]}</a></li>\n";
$content .= "</ol>\n";
// Todo Insert a table of contents here?
foreach($help_sections as $index => $section)
{
foreach($help_sections as $index => $section) {
// Todo add a button that you can click to get a permanent link
// to this section.
$content .= "<h2 id='$index' class='help-section-header'>" . $section["title"] . "</h2>\n";
$content .= "<h2 id='$index' class='help-section-header'>{$section["title"]}</h2>\n";
$content .= $section["content"] . "\n";
}
}