plugin:nspages
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:nspages [2020-05-23 14:04] – update version (2020-05-22). Fix a bug for -usePictures on namespaces gturri | plugin:nspages [2024-03-07 19:33] (current) – Tested OK with Kaos dregad | ||
---|---|---|---|
Line 6: | Line 6: | ||
email : guillaume.turri@gmail.com | email : guillaume.turri@gmail.com | ||
type : Syntax | type : Syntax | ||
- | lastupdate : 2020-05-22 | + | lastupdate : 2024-01-04 |
- | compatible : 2017-02-19, 2016-06-26a, | + | compatible : Igor, Jack Jackrum, Kaos+ |
depends | depends | ||
conflicts | conflicts | ||
Line 19: | Line 19: | ||
---- | ---- | ||
- | :!: **I'm looking for a co-maintainer!** | + | //**If your Dokuwiki instance is older than the release " |
- | If you' | + | This plugin nicely displays |
- | If you' | + | If you' |
- | ===== Description ===== | + | If you're interested in understanding all the options, in order to use it to best fit your needs, you may want to jump directly to the 2nd section. |
- | This plugin nicely displays a table of content of the pages -and optionally the subnamespaces- of a given (sub)namespace. | + | =====Some examples |
+ | |||
+ | ====The very first steps==== | ||
Using this plugin is easy: just write | Using this plugin is easy: just write | ||
< | < | ||
- | and see the result. | + | (You may also use the button {{http:// |
+ | |||
+ | You will get a list of your pages displayed in columns, like this: {{https:// | ||
+ | |||
+ | If you're interested in the list of the namespaces instead of the list of pages, try this: | ||
+ | <nspages -subns -nopages> | ||
+ | |||
+ | ====Pictures!==== | ||
+ | |||
+ | Now let's do something more colorful: if you have pictures in your pages you can do this: | ||
+ | <nspages -usePictures> | ||
+ | it will represent each page using their first picture, like this: | ||
+ | |||
+ | {{https:// | ||
+ | |||
+ | ====Tree==== | ||
+ | |||
+ | One last example: instead of displaying the content of a single namespace, let's display a hierarchy of pages as a tree. For the hype, let's use a whole bunch of options together (you can look at the next section in order to understand what each of those option does): | ||
+ | <nspages -tree -r -exclude -subns -pagesInNs -h1 -textNs=" | ||
+ | Bam, you get a tree like this: | ||
+ | |||
+ | {{https:// | ||
+ | |||
+ | This was just to get you started. This plugin is highly configurable and has a lot more features we haven' | ||
+ | |||
+ | =====Manual===== | ||
The general syntax is | The general syntax is | ||
Line 42: | Line 69: | ||
| < | | < | ||
| < | | < | ||
- | | < | + | | < |
| < | | < | ||
| < | | < | ||
| < | | < | ||
- | | < | + | | < |
| < | | < | ||
| < | | < | ||
Line 53: | Line 80: | ||
| < | | < | ||
| < | | < | ||
- | | < | + | | < |
- | | < | + | | < |
| < | | < | ||
| < | | < | ||
Line 62: | Line 89: | ||
| < | | < | ||
| < | | < | ||
+ | | < | ||
| < | | < | ||
| < | | < | ||
- | | < | + | | < |
| < | | < | ||
| < | | < | ||
Line 84: | Line 112: | ||
| < | | < | ||
| < | | < | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
ex: ''< | ex: ''< | ||
Line 90: | Line 122: | ||
Search and install the plugin using the [[plugin: | Search and install the plugin using the [[plugin: | ||
+ | |||
+ | =====Option -customTitle===== | ||
+ | |||
+ | //(Because the array above is too concise to give all the details about this option)// | ||
+ | |||
+ | This option accepts a string as an argument. The name of the pages will be displayed using this format. The {xxx} part are replaced by the metadata of the page. | ||
+ | |||
+ | For instance | ||
+ | |||
+ | <nspages : | ||
+ | |||
+ | could display: | ||
+ | |||
+ | * [1613513556] <Title of page 1> by Stancu | ||
+ | * [1624663245] <Title of page 2> by Guillaume | ||
+ | |||
+ | Some important details about this option: | ||
+ | * Nspages will render by default only the metadata //title//, //user//, and // | ||
+ | * The list of metadata available by default in Dokuwiki is available in the [[https:// | ||
+ | * It can be use along with other plugins that adds support for custom metadatas (like the [[https:// | ||
+ | |||
+ | ===== Option -sidebar ===== | ||
+ | |||
+ | DokuWiki supports [[faq: | ||
+ | |||
+ | Here is an example of sidebar generated with nspages: | ||
+ | |||
+ | {{https:// | ||
+ | |||
+ | To get this sidebar I just put | ||
+ | <nspages -simpleList -h1 -sidebar> | ||
+ | on the page '': | ||
+ | |||
+ | The tricky part is that since I do not specify a namespace then I expect nspages to consider the namespace of the current page. But by default nspages will consider that the current page is '': | ||
+ | |||
+ | That's the point of the '' | ||
+ | * tells nspages that the " | ||
+ | * does not cache the resolution of the resolution of the namespace (because it may change at every page that I browse) | ||
+ | (a consequence is that it makes no sense to both specify a namespace and have the '' | ||
+ | |||
+ | **To put it in a nutshell**: it you use nspages to generate a sidebar, then you should add the '' | ||
===== Some (important) points ===== | ===== Some (important) points ===== | ||
- | * With version older than 2014-08-10, you should put %%~~NOCACHE~~%% in the pages where you use this plugin, to make sure that if you create or remove a page in the namespace, it will be taken into account. Now, nspages automatically deactivate the cache on the pages where it is used (you can deactivate this behaviour on the admin panel). | + | * With version older than 2014-08-10, you should put '' |
- | * The CSS sheet should be taken into account in order for this plugin to work correctly; but because of the cache system it may not be the case the first time you use this plugin (even if %%~~NOCACHE~~%% is specified). The easier way to resolve this is to make sure your cache is invalidated by touching '' | + | * The CSS sheet should be taken into account in order for this plugin to work correctly; but because of the cache system it may not be the case the first time you use this plugin (even if '' |
- | * Currently, you may not use a '>' | + | * Currently, you may not use a ''>'' in the '' |
* When you change the default markup inserted by the toolbar button (throught the admin dashboard), you may need to purge your caches to have this change taken into effect (see also the [[https:// | * When you change the default markup inserted by the toolbar button (throught the admin dashboard), you may need to purge your caches to have this change taken into effect (see also the [[https:// | ||
* [[: | * [[: | ||
Line 107: | Line 180: | ||
==== To who ==== | ==== To who ==== | ||
- | + | Any NGO acting for the environment. | |
- | The preference goes to the [[https:// | + | |
- | + | ||
- | If it isn't possible, any association | + | |
==== How ==== | ==== How ==== | ||
Line 121: | Line 191: | ||
Making sure you have a positive impact would already be awesome: | Making sure you have a positive impact would already be awesome: | ||
* Volunteer to an NGO near you. Give some of your time | * Volunteer to an NGO near you. Give some of your time | ||
- | * Ride you bike instead of taking your car | + | |
- | * Buy local organic food | + | |
* Use a reusable bag and stop using plastic straws | * Use a reusable bag and stop using plastic straws | ||
* Plant trees | * Plant trees | ||
* Take only what you need, not what you can | * Take only what you need, not what you can | ||
plugin/nspages.1590235487.txt.gz · Last modified: 2020-05-23 14:04 by gturri