Differences

This shows you the differences between two versions of the page.

--- plugin:mark2memorize [2018-09-29 19:16] – shimamu
+++ plugin:mark2memorize [2020-02-26 09:57] (current) – Aleksandr
@@ Line 5: / Line 5: @@
 author     : shimamu
 email      : cooklecurry@gmail.com
-type       :
+type       : Action, Syntax
 lastupdate : 2018-09-29
 compatible : Greebo
@@ Line 11: / Line 11: @@
 conflicts  :
 similar    :
-tags       :
+tags       : marking, highlight
 downloadurl: https://github.com/shimamu/dokuwiki-mark-to-memorize-plugin/raw/master/dist/mark-to-memorize-plugin-main.zip
-bugtracker : # eg. http://github.com/shimamu/dokuwiki-plugin-mark2memorize/issues
+bugtracker : https://github.com/shimamu/dokuwiki-mark-to-memorize-plugin/issues
 sourcerepo : https://github.com/shimamu/dokuwiki-mark-to-memorize-plugin/
 donationurl:
@@ Line 21: / Line 21: @@
 ----
-//:!: 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 =====
-//[First, last and only chance to warn users before installing (some has already done that before reading this)]//
-:!: **External requirements:** This plugin requires the following additional components that must be installed separately:
-  * [[A banana]]
-  * [[Another banana]]
 Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
@@ Line 35: / Line 28: @@
 ===== Examples/Usage =====
-//[Most people learn by example, so this goes first]//
+==== 1. Add a tag ====
-See the plugin in action [[www.demosite.com|here]]. The sample page shows all the styles available with the plugin.
-A simple box:
+  <markmemo>Keyword</markmemo>
-  <box> the box contents </box>
+ways to add a tag:
+  * click the "Mark to Memorize" icon in the editor toolbar to insert a placeholder (**%%<markmemo>Mark to Memorize</markmemo>%%**)
+  * mark a text and click on the lock icon
+  * enter tags **%%<markmemo></markmemo>%%** manually
-Some more complex boxes
+==== 2. Switch show or hide ====
-  <box 80% round orange|a title> the box contents</box>
+After save, Keyword is covered by yellow mark.
-  <box 50% left blue>the box contents</box|a caption>
-  <box 60% round #f99 #fc9 #fcc #f60|title>the box contents></box|caption>
+When you click yellow mark, Keyword is shown.
+And you click once again, Keyword is covered again.
-//[Pictures showing the rendered result will help users to understand]//
 ===== Syntax =====
-//[Complete syntax]//
 Basic syntax:
-<code>{{actionlink>action|title}}</code>
+  <markmemo>Keyword</markmemo>
-  * **action** can be one of this:
-    * //edit//    --- edit/create/show
-    * //history// --- old revisions
 ===== Configuration and Settings =====
-//[also CSS style tips]//
+Nothing.
 ===== Development =====
@@ Line 71: / Line 62: @@
 === Change Log ===
-//[preferable GitHub RSS feed or similar]//
+  * **2018-09-30**
-  * **2009-01-01**
     * 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//