Browse Source

Move Rest API docs and create main php docs! Hooray!

This should make things _much_ easier.
first-run
Starbeamrainbowlabs 3 years ago
parent
commit
fad6d8f391
243 changed files with 42617 additions and 3053 deletions
  1. +7
    -9
      .gitignore
  2. +12
    -16
      Makefile
  3. +85
    -189
      Module_API_Docs.md
  4. +1
    -1
      README.md
  5. +0
    -1418
      RestApiDocs/api_data.js
  6. +0
    -1418
      RestApiDocs/api_data.json
  7. +7
    -0
      core.php
  8. +5
    -0
      docs/ModuleApi/.htaccess
  9. +376
    -0
      docs/ModuleApi/classes/PeppermintParsedown.html
  10. +425
    -0
      docs/ModuleApi/classes/Slimdown.html
  11. +536
    -0
      docs/ModuleApi/classes/ids.html
  12. +948
    -0
      docs/ModuleApi/classes/page_renderer.html
  13. +902
    -0
      docs/ModuleApi/classes/search.html
  14. +732
    -0
      docs/ModuleApi/css/bootstrap-combined.no-icons.min.css
  15. +403
    -0
      docs/ModuleApi/css/font-awesome.min.css
  16. +65
    -0
      docs/ModuleApi/css/jquery.iviewer.css
  17. +3
    -0
      docs/ModuleApi/css/phpdocumentor-clean-icons/Read Me.txt
  18. +17
    -0
      docs/ModuleApi/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.dev.svg
  19. BIN
      docs/ModuleApi/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.eot
  20. +17
    -0
      docs/ModuleApi/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.svg
  21. BIN
      docs/ModuleApi/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.ttf
  22. BIN
      docs/ModuleApi/css/phpdocumentor-clean-icons/fonts/phpdocumentor-clean-icons.woff
  23. +30
    -0
      docs/ModuleApi/css/phpdocumentor-clean-icons/lte-ie7.js
  24. +48
    -0
      docs/ModuleApi/css/phpdocumentor-clean-icons/style.css
  25. +204
    -0
      docs/ModuleApi/css/prism.css
  26. +429
    -0
      docs/ModuleApi/css/template.css
  27. +2449
    -0
      docs/ModuleApi/files/core.html
  28. +1772
    -0
      docs/ModuleApi/files/core.php.txt
  29. +250
    -0
      docs/ModuleApi/files/download.html
  30. +94
    -0
      docs/ModuleApi/files/download.php.txt
  31. +250
    -0
      docs/ModuleApi/files/modules.action-hash.html
  32. +250
    -0
      docs/ModuleApi/files/modules.action-protect.html
  33. +250
    -0
      docs/ModuleApi/files/modules.action-random.html
  34. +250
    -0
      docs/ModuleApi/files/modules.action-raw.html
  35. +250
    -0
      docs/ModuleApi/files/modules.api-status.html
  36. +309
    -0
      docs/ModuleApi/files/modules.extra-sidebar.html
  37. +504
    -0
      docs/ModuleApi/files/modules.feature-comments.html
  38. +250
    -0
      docs/ModuleApi/files/modules.feature-guiconfig.html
  39. +315
    -0
      docs/ModuleApi/files/modules.feature-history.html
  40. +395
    -0
      docs/ModuleApi/files/modules.feature-recent-changes.html
  41. +250
    -0
      docs/ModuleApi/files/modules.feature-redirect.html
  42. +257
    -0
      docs/ModuleApi/files/modules.feature-search.html
  43. +386
    -0
      docs/ModuleApi/files/modules.feature-stats.html
  44. +514
    -0
      docs/ModuleApi/files/modules.feature-upload.html
  45. +250
    -0
      docs/ModuleApi/files/modules.feature-user-preferences.html
  46. +250
    -0
      docs/ModuleApi/files/modules.page-credits.html
  47. +250
    -0
      docs/ModuleApi/files/modules.page-debug-info.html
  48. +250
    -0
      docs/ModuleApi/files/modules.page-delete.html
  49. +250
    -0
      docs/ModuleApi/files/modules.page-edit.html
  50. +250
    -0
      docs/ModuleApi/files/modules.page-export.html
  51. +250
    -0
      docs/ModuleApi/files/modules.page-help.html
  52. +304
    -0
      docs/ModuleApi/files/modules.page-list.html
  53. +306
    -0
      docs/ModuleApi/files/modules.page-login.html
  54. +250
    -0
      docs/ModuleApi/files/modules.page-logout.html
  55. +250
    -0
      docs/ModuleApi/files/modules.page-move.html
  56. +250
    -0
      docs/ModuleApi/files/modules.page-update.html
  57. +250
    -0
      docs/ModuleApi/files/modules.page-user-list.html
  58. +250
    -0
      docs/ModuleApi/files/modules.page-view.html
  59. +257
    -0
      docs/ModuleApi/files/modules.parser-default-old.html
  60. +257
    -0
      docs/ModuleApi/files/modules.parser-parsedown.html
  61. +51
    -0
      docs/ModuleApi/files/modules/action-hash.php.txt
  62. +63
    -0
      docs/ModuleApi/files/modules/action-protect.php.txt
  63. +32
    -0
      docs/ModuleApi/files/modules/action-random.php.txt
  64. +39
    -0
      docs/ModuleApi/files/modules/action-raw.php.txt
  65. +50
    -0
      docs/ModuleApi/files/modules/api-status.php.txt
  66. +122
    -0
      docs/ModuleApi/files/modules/extra-sidebar.php.txt
  67. +341
    -0
      docs/ModuleApi/files/modules/feature-comments.php.txt
  68. +200
    -0
      docs/ModuleApi/files/modules/feature-guiconfig.php.txt
  69. +98
    -0
      docs/ModuleApi/files/modules/feature-history.php.txt
  70. +269
    -0
      docs/ModuleApi/files/modules/feature-recent-changes.php.txt
  71. +37
    -0
      docs/ModuleApi/files/modules/feature-redirect.php.txt
  72. +884
    -0
      docs/ModuleApi/files/modules/feature-search.php.txt
  73. +229
    -0
      docs/ModuleApi/files/modules/feature-stats.php.txt
  74. +663
    -0
      docs/ModuleApi/files/modules/feature-upload.php.txt
  75. +233
    -0
      docs/ModuleApi/files/modules/feature-user-preferences.php.txt
  76. +146
    -0
      docs/ModuleApi/files/modules/page-credits.php.txt
  77. +77
    -0
      docs/ModuleApi/files/modules/page-debug-info.php.txt
  78. +120
    -0
      docs/ModuleApi/files/modules/page-delete.php.txt
  79. +459
    -0
      docs/ModuleApi/files/modules/page-edit.php.txt
  80. +77
    -0
      docs/ModuleApi/files/modules/page-export.php.txt
  81. +154
    -0
      docs/ModuleApi/files/modules/page-help.php.txt
  82. +154
    -0
      docs/ModuleApi/files/modules/page-list.php.txt
  83. +160
    -0
      docs/ModuleApi/files/modules/page-login.php.txt
  84. +41
    -0
      docs/ModuleApi/files/modules/page-logout.php.txt
  85. +132
    -0
      docs/ModuleApi/files/modules/page-move.php.txt
  86. +89
    -0
      docs/ModuleApi/files/modules/page-update.php.txt
  87. +49
    -0
      docs/ModuleApi/files/modules/page-user-list.php.txt
  88. +181
    -0
      docs/ModuleApi/files/modules/page-view.php.txt
  89. +166
    -0
      docs/ModuleApi/files/modules/parser-default-old.php.txt
  90. +669
    -0
      docs/ModuleApi/files/modules/parser-parsedown.php.txt
  91. +250
    -0
      docs/ModuleApi/files/pack.html
  92. +99
    -0
      docs/ModuleApi/files/pack.php.txt
  93. +250
    -0
      docs/ModuleApi/files/settings.fragment.html
  94. +65
    -0
      docs/ModuleApi/files/settings.fragment.php.txt
  95. BIN
      docs/ModuleApi/font/FontAwesome.otf
  96. BIN
      docs/ModuleApi/font/fontawesome-webfont.eot
  97. +504
    -0
      docs/ModuleApi/font/fontawesome-webfont.svg
  98. BIN
      docs/ModuleApi/font/fontawesome-webfont.ttf
  99. BIN
      docs/ModuleApi/font/fontawesome-webfont.woff
  100. +163
    -0
      docs/ModuleApi/graphs/class.html

+ 7
- 9
.gitignore View File

@ -2,30 +2,28 @@
*.md
# All the previous revisions
*.md.r*
# Include the README
!README.md
# ...but ignore READMEs in the build folder
build/README.md
# ...and the backup peppermint.json files created when using the settings GUI
peppermint.json.bak
# And the Module API Docs
# But keep the useful markdown files
!Module_API_Docs.md
# And the changelog
!Changelog.md
# And the development notes
!Development.md
# The page index
# Ignore the php documentor cache folder
docs/ModuleApiCache
# Ignore the various indexes created by pepperminty wiki
pageindex.json
# The id index
idindex.json
# The search index
invindex.json
# The recent changes list
recent-changes.json
# The statistics cache file
build/statsindex.json
# The new settings file
peppermint.json
# The comments files
build/*.comments.json


+ 12
- 16
Makefile View File

@ -1,6 +1,6 @@
.DEFAULT_GOAL := peppermint
.PHONY: setupApiDoc peppermint docs gh-pages
.PHONY: setupApiDoc peppermint docs rest_docs module_api_docs
ApiDocPresent := $(shell sh -c apidoc --help 1\>/dev/null && rm -rf doc/)
@ -8,11 +8,20 @@ peppermint:
@echo [peppermint/build] Rebuilding Pepperminty Wiki
php build.php
docs: setupApiDoc
docs: rest_docs module_api_docs
rest_docs: setupApiDoc
@echo [peppermint/docs] Building docs
apidoc -o './RestApiDocs/' --config apidoc.json -f '.*\.php' -e index.php
apidoc -o './docs/RestApi/' --config apidoc.json -f '.*\.php' -e index.php
rm -rf doc/
module_api_docs: phpdoc
@echo [peppermint/module api docs] Updating module api docs
php phpdoc run --directory . --target docs/ModuleApi --cache-folder docs/ModuleApiCache --ignore build/,php_error.php,Parsedown*,*.html --title "Pepperminty Wiki Module API" --visibility public
phpdoc:
curl -L https://phpdoc.org/phpDocumentor.phar -o phpdoc
setupApiDoc:
@echo [peppermint] Checking for apiDoc
ifndef ApiDocPresent
@ -21,16 +30,3 @@ ifndef ApiDocPresent
npm install apidoc --global
endif
@echo [peppermint] Check complete
gh-pages:
@echo [peppermint/gh-pages] Syncing master branch with gh-pages branch.
@echo [peppermint/gh-pages] Making sure the working directory is clean.
# From http://unix.stackexchange.com/a/155077/64687
git diff --exit-code
git diff --cached --exit-code
git checkout gh-pages
git rebase master
git push origin gh-pages
git checkout master
@echo '[peppermint/gh-pages] Sync complete.'

+ 85
- 189
Module_API_Docs.md View File

@ -1,195 +1,28 @@
Module API Documentation
========================
The core of Pepperminty Wik exposes several global objects and functions that you can use to write your own modules. This page documents these objects and functions so that you can create your own modules more easily.
# Developer Documentation
The core of Pepperminty Wiki exposes several global objects, classes, functions, and miscellaneous files that you can use to write your own modules. This page documents these them so that you can create your own modules more easily.
Indexes
-------
Pepperminty Wiki maintains several indexes containing various information about the current site that you can utilise. Some of them also have an 'API' of sorts that you can use to interact with them.
## Table of Contents
- [Rest API](#rest-api)
- [Module API](#module-api)
- [Global Variables](#global-variables)
- [Files](#files)
- [`pageindex.json`](#pageindex.json)
- [`idindex.json`](#idindex.json)
- [`invindex.json`](#invindex.json)
- [`recent-changes.json`](#recent-changes.json)
- [`statsindex.json`](#statsindex.json)
### `pageindex.json`
This is by _far_ the most important index. It contains an entry for each page, under which a number of interesting pieces of information are stored. It's automatically loaded into the global variable `$pageindex` too, so you don't even have to read it in. Here's an example pageindex:
```json
{
"Internal link": {
"filename": "Internal link.md",
"size": 120,
"lastmodified": 1446019377,
"lasteditor": "admin",
"tags": [
"testing",
"test tag with spaces",
"really really really really really really long tag"
]
},
"Main Page": {
"filename": "Main Page.md",
"size": 151,
"lastmodified": 1446388276,
"lasteditor": "admin",
"tags": []
},
"Internal link\/Sub": {
"filename": "Internal link\/Sub.md",
"size": 35,
"lastmodified": 1446370194,
"lasteditor": "admin",
"tags": [
"test"
]
},
"Files\/AJ Scr.png": {
"filename": "Files\/AJ Scr.png.md",
"size": 29,
"lastmodified": 1445501914,
"lasteditor": "admin",
"uploadedfile": true,
"uploadedfilepath": "Files\/AJ Scr.png",
"uploadedfilemime": "image\/png"
}
}
```
Currently, Pepperminty Wiki is configured to pretty print the json in the pageindex when saving it to disk, so if you find yourself saving the pageindex please do the same.
Now that alternate data storage directories are supported, the `$entry->filename` will *not* contain the `$env->storage_prefix` prefix. You will need to add this manually if you use it.
### `idindex.json`
The id index converts page ids into page names and vice versa. It's loaded into the global variable `$idindex`, but you normally wouldn't need to touch that, as there's a seamless API that you can use instead:
#### `ids::getid($pagename)`
Gets the id associated with the given pagename. If it doesn't exist it will be created.
#### `ids::getpagename($id)`
Gets the page name associated with the given id. If it doesn't exist `false` will be returned.
Functions
---------
### `register_module($module_info)`
Register a new module with Pepperminty Wiki. This is the most important function. Here's an example:
```php
<?php
register_module([
"name" => "Human readable module name", // The name of your module, will be shown to users
"version" => "0.1", // The version number
"author" => "Author Name", // Your name
"description" => "Module Description", // A description of your module. Shown in the module downloader.
"id" => "module-id", // An id for your module name. Should be filename safe with no spaces or capital letters.
"code" => function() {
// Insert your module's code here
}
]);
?>
```
The function that you provide will be executed after the initial setup has been completed.
### `module_exists($id)`
Checks to see if a module with the given id is currently loaded. Very useful for providing optional integration with other modules. Note that this may return false if all the modules haven't been loaded yet. All the modules are guaranteed to be loaded by the time the code in the `"code"` function is executed.
```php
<?php
module_exists("feature-search"); // Returns true if the feature-search module is loaded, false otherwise.
```
### `add_action($action_name, $code)`
Since Pepperminty Wiki works through actions via the GET parameter `action`, there is a function that lets you register a new handler for any given action. Note that you should call this inside the function you passed to `register_handler()`. Here's an example:
## Rest API
The REST api provided by Pepperminty Wiki itself is documented for bot owners and software developers alike over on GitHub pages [here](https://sbrl.github.io/Pepperminty-Wiki/docs/RestAPI).
```php
<?php
register_module([
"name" => "Human readable module name",
"version" => "0.1",
"author" => "Author Name",
"description" => "Module Description",
"id" => "module-id",
"code" => function() {
add_action("action_name", function() {
exit("Hello, World!");
});
}
]);
## Module API
The main PHP-based module API is documented with php documentor. The docs can be found [here](https://sbrl.github.io/Pepperminty-Wiki/docs/ModuleApi), hosted on GitHub Pages.
?>
This documentation covers all the functions and classes available in both the Pepperminty Wiki core, and the modules stored in this repository - as well as mentioning which module they are a part of.
```
There are one or two additional things that haven't made their way into the module api docs, which are detailed below:
The above adds an action called `action_name`, which, when requested, outputs the text `Hello, World!`.
### `register_save_preprocessor($function)`
Registers a function to be called every time a page is edited. The function will be passed the following parameters:
1. A reference to the pageindex entry that is about to be saved.
2. The new text that is to replace the old text.
3. The old text that the new text is going to replace.
If you make the function that you pass here take the new text that is to be saved in as a reference, you may alter it before it is saved to disk.
### `page_renderer`
You probably want your module to output a nice user-friendly page instead of a simple text-based one. Luckily, Pepperminty Wiki has a system to let you do that.
#### `page_renderer::render_main($title, $content)`
This is the main page rendering function you'll want to use. It renders and returns a page much the same as the default `view` action does. Here's an example:
```php
<?php
exit(page_renderer::render_main("Page title", "Page content"));
?>
```
#### `page_renderer::render_minimal($title, $content)`
Similar to the above, but renders a printable page instead. For an example, click the "Printable" button at the top of any page on Pepperminty Wiki.
```php
<?php
exit(page_renderer::render_minimal("Page title", "Page content"));
?>
```
#### `page_renderer::render_username($name)`
Renders a username. Currently all this function does is prepend `$settings->admin_display_char` to the username if they are an admin. Example:
```php
<?php
exit(page_renderer::render_username("admin")); // Output would be something like "&#9670;admin".
?>
```
#### `page_renderer::AddJSLink(string $scriptUrl)`
Add a remote JS script to rendered pages. Links added via this method translate to something like `<script src='{script url}' defer></script>`.
```php
<?php
page_renderer::AddJSLink("http://bobsrockets.com/js/awesomescript.js");
?>
```
#### `page_renderer::AddJSSnippet(string $snippet)`
Adds a snippet of javascript to generated pages. The snippet in question will be guaranteed to run after the DOM content has loaded (but the `onload` event may not have fired yet). Snippets added via this method will be translated into something like `<script defer>{snippet}</script>`.
```php
<?php
page_renderer::AddJSSnippet("alert('Hai!');");
?>
```
#### `page_renderer::register_part_preprocessor($code)`
### `page_renderer::register_part_preprocessor($code)`
This function's use is more complicated to explain. Pepperminty Wiki renders pages with a very simple templating system. For example, in the template a page's content is denoted by `{content}`. A function registered here will be passed all the components of a page _just_ before they are dropped into the template. Note that the function you pass in here should take a *reference* to the components, as the return value of the function passed is discarded. Here's an example:
```php
@ -251,9 +84,8 @@ register_module([
```
Variables
---------
There are a number of global variables floatign around that can give you a lot of information about the current request. ~~I will be tidying them up into a single `$env` object soon.~~ Most of the below have been tidied up into a single `$env` object now! Below is a table of all the variables Pepperminty Wiki has lying around:
### Global Variables
There are a number of global variables floating around that can give you a lot of information about the current request. ~~I will be tidying them up into a single `$env` object soon.~~ Most of the below have been tidied up into a single `$env` object now! Below is a table of all the variables Pepperminty Wiki has lying around:
Variable | Description
------------------------|------------------------------------------
@ -265,3 +97,67 @@ Variable | Description
`$env->action` | The current action.
`$settings` | The settings object from the top of the file.
`$pageindex` | Contains a list of all the pages that Pepperminty Wiki currently knows about, along with information about each page. Exists to improve performance.
## Files
Pepperminty Wiki maintains several files (most of which are indexes) containing various information about the current site that you can utilise. Some of them also have an 'API' of sorts that you can use to interact with them - which is documented in the [module api](#module-api) above.
### `pageindex.json`
This is by _far_ the most important index. It contains an entry for each page, under which a number of interesting pieces of information are stored. It's automatically loaded into the global variable `$pageindex` too, so you don't even have to read it in. Here's an example pageindex:
```json
{
"Internal link": {
"filename": "Internal link.md",
"size": 120,
"lastmodified": 1446019377,
"lasteditor": "admin",
"tags": [
"testing",
"test tag with spaces",
"really really really really really really long tag"
]
},
"Main Page": {
"filename": "Main Page.md",
"size": 151,
"lastmodified": 1446388276,
"lasteditor": "admin",
"tags": []
},
"Internal link\/Sub": {
"filename": "Internal link\/Sub.md",
"size": 35,
"lastmodified": 1446370194,
"lasteditor": "admin",
"tags": [
"test"
]
},
"Files\/AJ Scr.png": {
"filename": "Files\/AJ Scr.png.md",
"size": 29,
"lastmodified": 1445501914,
"lasteditor": "admin",
"uploadedfile": true,
"uploadedfilepath": "Files\/AJ Scr.png",
"uploadedfilemime": "image\/png"
}
}
```
Currently, Pepperminty Wiki is configured to pretty print the json in the pageindex when saving it to disk, so if you find yourself saving the pageindex please do the same.
Now that alternate data storage directories are supported, the `$entry->filename` will *not* contain the `$env->storage_prefix` prefix. You will need to add this manually if you use it.
### `idindex.json`
The id index converts page ids into page names and vice versa. It's loaded into the global variable `$idindex`, but you normally wouldn't need to touch that, as there's a seamless API that you can use instead, which can be found under the `ids` class.
### `invindex.json`
This is the main search index. Obviously, it's only present if the `feature-search` module is loaded and active. It can be interacted with though the `search` class that the `feature-search` module exposes.
### `recent-changes.json`
This is not loaded automatically, but it contains a list of recent changes that have occurred throughout the wiki. You don't have to fiddle with it directly though if you just want to add a new change, because the `feature-recent-changes` module has a fewe handy methods you can use for that purpose.
### `statsindex.json`
This file is brand new as of v0.15, and contains the most recently calculated statistics about the wiki. The `feature-stats` module oversees the regeneration of this file. Consult if you need access to such statistics that might be somewhat expensive to calculate.

+ 1
- 1
README.md View File

@ -171,7 +171,7 @@ Key | Value | Explanation
## Module API Reference
I have documented (most of) the current API that you can use to create your own modules. You can find it in the [Module_API_Docs.md](https://github.com/sbrl/Pepperminty-Wiki/blob/master/Module_API_Docs.md) file in this repository.
I've also documented Pepperminty Wiki's entire REST API using [apiDoc](http://apidocjs.com/). You can view the docs [here](https://sbrl.github.io/Pepperminty-Wiki/RestApiDocs/).
I've also documented Pepperminty Wiki's entire REST API using [apiDoc](http://apidocjs.com/). You can view the docs [here](https://sbrl.github.io/Pepperminty-Wiki/docs/RestApiDocs/).
If you do create a module, I'd love to hear about it. Even better, [send a pull request](https://github.com/sbrl/Pepperminty-Wiki/pulls/new)!


+ 0
- 1418
RestApiDocs/api_data.js
File diff suppressed because it is too large
View File


+ 0
- 1418
RestApiDocs/api_data.json
File diff suppressed because it is too large
View File


+ 7
- 0
core.php View File

@ -1123,6 +1123,13 @@ class page_renderer
/**
* Registers a function as a part post processor.
* This function's use is more complicated to explain. Pepperminty Wiki
* renders pages with a very simple templating system. For example, in the
* template a page's content is denoted by `{content}`. A function
* registered here will be passed all the components of a page _just_
* before they are dropped into the template. Note that the function you
* pass in here should take a *reference* to the components, as the return
* value of the function passed is discarded.
* @package core
* @param function $function The part preprocessor to register.
*/


+ 5
- 0
docs/ModuleApi/.htaccess View File

@ -0,0 +1,5 @@
# Fixes a vulnerability in CentOS: http://stackoverflow.com/questions/20533279/prevent-php-from-parsing-non-php-files-such-as-somefile-php-txt
<FilesMatch \.php\.txt$>
RemoveHandler .php
ForceType text/plain
</FilesMatch>

+ 376
- 0
docs/ModuleApi/classes/PeppermintParsedown.html View File

@ -0,0 +1,376 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>Pepperminty Wiki Module API</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="../js/html5.js"></script>
<![endif]-->
<script src="../js/jquery-1.11.0.min.js"></script>
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">Pepperminty Wiki Module API</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">6</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">0</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1060053167"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-1060053167" class="accordion-body collapse in">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/ids.html">ids</a></li>
<li class="class"><a href="../classes/page_renderer.html">page_renderer</a></li>
<li class="class"><a href="../classes/PeppermintParsedown.html">PeppermintParsedown</a></li>
<li class="class"><a href="../classes/search.html">search</a></li>
<li class="class"><a href="../classes/Slimdown.html">Slimdown</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\</small>PeppermintParsedown</h1>
<p><em></em></p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/PeppermintParsedown.html#method___construct" class="">__construct()</a><br />
<a href="../classes/PeppermintParsedown.html#method_setInternalLinkBase" class="">setInternalLinkBase()</a><br />
</section>
<section class="span4">
<em>No public properties found</em>
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<em>No protected methods found</em>
</section>
<section class="span4">
<em>No protected properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<em>No private methods found</em>
</section>
<section class="span4">
<em>No private properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/modules.parser-parsedown.html"><div class="path-wrapper">modules/parser-parsedown.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">Default</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\ParsedownExtra</div>
<div class="namespace-wrapper">\PeppermintParsedown</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method___construct" name="method___construct" class="anchor"></a>
<article class="method">
<h3 class="public ">__construct()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">__construct() </pre>
<p><em></em></p>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_setInternalLinkBase" name="method_setInternalLinkBase" class="anchor"></a>
<article class="method">
<h3 class="public ">setInternalLinkBase()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">setInternalLinkBase(string <span class="argument">$url</span>) </pre>
<p><em>Sets the base url to be used for internal links. &#039;%s&#039; will be replaced
with a URL encoded version of the page name.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td>string</td>
<td>$url </td>
<td><p>The url to use when parsing internal links.</p></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">parser-parsedown.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/modules/parser-parsedown.php.txt" class="language-php line-numbers"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>

+ 425
- 0
docs/ModuleApi/classes/Slimdown.html View File

@ -0,0 +1,425 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>Pepperminty Wiki Module API</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="../js/html5.js"></script>
<![endif]-->
<script src="../js/jquery-1.11.0.min.js"></script>
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">Pepperminty Wiki Module API</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">6</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">0</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-610538792"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-610538792" class="accordion-body collapse in">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/ids.html">ids</a></li>
<li class="class"><a href="../classes/page_renderer.html">page_renderer</a></li>
<li class="class"><a href="../classes/PeppermintParsedown.html">PeppermintParsedown</a></li>
<li class="class"><a href="../classes/search.html">search</a></li>
<li class="class"><a href="../classes/Slimdown.html">Slimdown</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\</small>Slimdown</h1>
<p><em>Modified by Starbeamrainbowlabs (starbeamrainbowlabs)</em></p>
<p>Changed bold to use single asterisks
Changed italics to use single underscores
Added one to add the heading levels (no <h1> tags allowed)
Added wiki style internal link parsing
Added wiki style internal link parsing with display text
Added image support</p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/Slimdown.html#method_add_rule" class="">add_rule()</a><br />
<a href="../classes/Slimdown.html#method_render" class="">render()</a><br />
</section>
<section class="span4">
<a href="../classes/Slimdown.html#property_rules" class="">$rules</a><br />
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<em>No protected methods found</em>
</section>
<section class="span4">
<em>No protected properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<em>No private methods found</em>
</section>
<section class="span4">
<em>No private properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/modules.parser-default-old.html"><div class="path-wrapper">modules/parser-default-old.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">Default</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\Slimdown</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="properties" name="properties"></a>
<div class="row-fluid">
<div class="span8 content class">
<h2>Properties</h2>
</div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="property_rules" name="property_rules" class="anchor"></a>
<article class="property">
<h3 class="public ">$rules</h3>
<pre class="signature">$rules : </pre>
<p><em></em></p>
<h4>Type</h4>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_add_rule" name="method_add_rule" class="anchor"></a>
<article class="method">
<h3 class="public ">add_rule()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">add_rule( <span class="argument">$regex</span>, <span class="argument">$replacement</span>) </pre>
<p><em>Add a rule.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$regex </td>
<td></td>
</tr>
<tr>
<td></td>
<td>$replacement </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_render" name="method_render" class="anchor"></a>
<article class="method">
<h3 class="public ">render()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">render( <span class="argument">$text</span>) </pre>
<p><em>Render some Markdown into HTML.</em></p>
<h4>Parameters</h4>
<table class="table table-condensed table-hover">
<tr>
<td></td>
<td>$text </td>
<td></td>
</tr>
</table>
</article>
</div>
<aside class="span4 detailsbar">
<h1><i class="icon-arrow-down"></i></h1>
<span class="label label-info">static</span>
<dl>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
</div>
</section>
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
<h3 id="source-view-label">parser-default-old.php</h3>
</div>
<div class="modal-body">
<pre data-src="../files/modules/parser-default-old.php.txt" class="language-php line-numbers"></pre>
</div>
</div>
<footer class="row-fluid">
<section class="span10 offset2">
<section class="row-fluid">
<section class="span10 offset1">
<section class="row-fluid footer-sections">
<section class="span4">
<h1><i class="icon-code"></i></h1>
<div>
<ul>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-bar-chart"></i></h1>
<div>
<ul>
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
</ul>
</div>
</section>
<section class="span4">
<h1><i class="icon-pushpin"></i></h1>
<div>
<ul>
<li><a href="../reports/errors.html">Errors</a></li>
<li><a href="../reports/markers.html">Markers</a></li>
</ul>
</div>
</section>
</section>
</section>
</section>
<section class="row-fluid">
<section class="span10 offset1">
<hr />
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
on September 16th, 2017 at 10:22.
</section>
</section>
</section>
</footer>
</div>
</body>
</html>

+ 536
- 0
docs/ModuleApi/classes/ids.html View File

@ -0,0 +1,536 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title>Pepperminty Wiki Module API</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/prism.css" rel="stylesheet" media="all"/>
<link href="../css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="../js/html5.js"></script>
<![endif]-->
<script src="../js/jquery-1.11.0.min.js"></script>
<script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/jquery.smooth-scroll.js"></script>
<script src="../js/prism.min.js"></script>
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
<script type="text/javascript">
function loadExternalCodeSnippets() {
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
var src = pre.getAttribute('data-src');
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
var language = 'php';
var code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState == 4) {
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
}
else if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
}
else {
code.textContent = '✖ Error: File does not exist or is empty';
}
}
};
xhr.send(null);
});
}
$(document).ready(function(){
loadExternalCodeSnippets();
});
$('#source-view').on('shown', function () {
loadExternalCodeSnippets();
})
</script>
<link rel="shortcut icon" href="../images/favicon.ico"/>
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<i class="icon-ellipsis-vertical"></i>
</a>
<a class="brand" href="../index.html">Pepperminty Wiki Module API</a>
<div class="nav-collapse">
<ul class="nav pull-right">
<li class="dropdown" id="charts-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../graphs/class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="../reports/errors.html">
<i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">84</span>
</a>
</li>
<li>
<a href="../reports/markers.html">
<i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">6</span>
</a>
</li>
<li>
<a href="../reports/deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">0</span>
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<!--<div class="go_to_top">-->
<!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
<!--</div>-->
</div>
<div id="___" class="container-fluid">
<section class="row-fluid">
<div class="span2 sidebar">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-459313590"></a>
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
</div>
<div id="namespace-459313590" class="accordion-body collapse in">
<div class="accordion-inner">
<ul>
<li class="class"><a href="../classes/ids.html">ids</a></li>
<li class="class"><a href="../classes/page_renderer.html">page_renderer</a></li>
<li class="class"><a href="../classes/PeppermintParsedown.html">PeppermintParsedown</a></li>
<li class="class"><a href="../classes/search.html">search</a></li>
<li class="class"><a href="../classes/Slimdown.html">Slimdown</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</section>
<section class="row-fluid">
<div class="span10 offset2">
<div class="row-fluid">
<div class="span8 content class">
<nav>
<a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i>
</nav>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
<h1><small>\</small>ids</h1>
<p><em>Provides an interface to interact with page ids.</em></p>
<section id="summary">
<h2>Summary</h2>
<section class="row-fluid heading">
<section class="span4">
<a href="#methods">Methods</a>
</section>
<section class="span4">
<a href="#properties">Properties</a>
</section>
<section class="span4">
<a href="#constants">Constants</a>
</section>
</section>
<section class="row-fluid public">
<section class="span4">
<a href="../classes/ids.html#method_getid" class="">getid()</a><br />
<a href="../classes/ids.html#method_getpagename" class="">getpagename()</a><br />
<a href="../classes/ids.html#method_movepagename" class="">movepagename()</a><br />
<a href="../classes/ids.html#method_deletepagename" class="">deletepagename()</a><br />
<a href="../classes/ids.html#method_clear" class="">clear()</a><br />
</section>
<section class="span4">
<em>No public properties found</em>
</section>
<section class="span4">
<em>No constants found</em>
</section>
</section>
<section class="row-fluid protected">
<section class="span4">
<em>No protected methods found</em>
</section>
<section class="span4">
<em>No protected properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
<section class="row-fluid private">
<section class="span4">
<em>No private methods found</em>
</section>
<section class="span4">
<em>No private properties found</em>
</section>
<section class="span4">
<em>N/A</em>
</section>
</section>
</section>
</div>
<aside class="span4 detailsbar">
<dl>
<dt>File</dt>
<dd><a href="../files/core.html"><div class="path-wrapper">core.php</div></a></dd>
<dt>Package</dt>
<dd><div class="namespace-wrapper">core</div></dd>
<dt>Class hierarchy</dt>
<dd class="hierarchy">
<div class="namespace-wrapper">\ids</div>
</dd>
</dl>
<h2>Tags</h2>
<table class="table table-condensed">
<tr><td colspan="2"><em>None found</em></td></tr>
</table>
</aside>
</div>
<a id="methods" name="methods"></a>
<div class="row-fluid">
<div class="span8 content class"><h2>Methods</h2></div>
<aside class="span4 detailsbar"></aside>
</div>
<div class="row-fluid">
<div class="span8 content class">
<a id="method_getid" name="method_getid" class="anchor"></a>
<article class="method">
<h3 class="public ">getid()</h3>
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
<pre class="signature" style="margin-right: 54px;">getid(string <span class="argument">$pagename</span>) : integer</pre>
<p><em>Gets the page id associated with the given page name.</em></p>
<p>If it doesn't exist in the id index, it will be added.</p>