Browse Source

Minor - Update the readme files - refs #7279

Angel Fernando Quiroz Campos 10 years ago
parent
commit
11f912d857
2 changed files with 44 additions and 6 deletions
  1. 24 2
      plugin/tour/README.md
  2. 20 4
      plugin/tour/readme.txt

+ 24 - 2
plugin/tour/README.md

@@ -1,3 +1,25 @@
-# Chamilo Tour Plugin
+Chamilo Tour Plugin
+===================
 
-Shows people how to use your Chamilo LMS
+Shows people how to use your Chamilo LMS
+
+# Set the blocks for the tour
+
+Edit the plugin/tour/config/tour.json file adding the page classes and steps
+
+To set the steps in a page, add a object like this:
+```
+{
+    "pageClass": "page unique class selector",
+    "steps": [
+        {
+            "elementSelector": "element class or id",
+            "message": "Language variable"
+        },
+        {
+            "elementSelector": "element class or id",
+            "message": "Language variable"
+        },
+    ]
+}
+```

+ 20 - 4
plugin/tour/readme.txt

@@ -1,4 +1,20 @@
-Chamilo Tour Plugin<br>
-===================<br>
-<br>
-Shows people how to use your Chamilo LMS<br>
+<h1>Chamilo Tour Plugin</h1>
+<p>Shows people how to use your Chamilo LMS</p>
+<h2>Set the blocks for the tour</h2>
+<p>Edit the plugin/tour/config/tour.json file adding the page classes and steps</p>
+<p>To set the steps in a page, add a object like this:</p>
+<pre>
+{
+    "pageClass": "page unique class selector",
+    "steps": [
+        {
+            "elementSelector": "element class or id",
+            "message": "Language variable"
+        },
+        {
+            "elementSelector": "element class or id",
+            "message": "Language variable"
+        },
+    ]
+}
+</pre>