This is an old revision of the document!
Table of Contents
Mark To Memorize Plugin
Compatible with DokuWiki
Greebo
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
This template contains various hints on how to fill in data (formatted in italics). Be sure to remove the hints and unwanted sections (Eg. the Syntax/Example section for non-syntax plugins.
Installation
Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.
Examples/Usage
[Most people learn by example, so this goes first]
See the plugin in action here. The sample page shows all the styles available with the plugin.
A simple tag:
<markmemo>Keyword</markmemo>
3 ways to add a tag:
- click the “Mark to Memorize” icon in the editor toolbar to insert a placeholder (<markmemo>Keyword</markmemo>)
- mark a text and click on the lock icon
- enter tags <markmemo></markmemo> manually
After save, Keyword is covered by yellow mark.
When you click yellow mark, Keyword is shown.
And you click once again, Keyword is hidden.
[Pictures showing the rendered result will help users to understand]
Syntax
Basic syntax:
<markmemo>Keyword</markmemo>
Configuration and Settings
Nothing.
Development
[downloadable blocks, development comments]
Change Log
- 2018-09-30
- Initial release
Known Bugs and Issues
[this section might not be needed in case of external bug manager, or use RSS feed]
ToDo/Wish List
[developers roadmap]
FAQ
[discussions should ideally be deleted and turned into FAQ entries along the way]
Discussion
Could be placed on an external page (e.g. plugin:pluginname:discussion) to have a distinction between user comments and author docs