Guided Tour: Difference between revisions

Latest revision as of 08:19, 3 September 2017

GSoC 2017
Guided Tour Project Documentation

Joomla!

4.x

Introduction

Currently, we have only the Help Screens to help new Joomla Users to get an overview of any component view. To help make it easier and more interactive for new users, this project has been submitted.

Prerequisites

The testing environment requires your local machine with the Joomla! CMS 4 installed with the branch( https://github.com/joomla-projects/gsoc17_helpscreens_on_jdocs/pull/7 ).
A Plugin of the Tour Guide ( https://drive.google.com/open?id=0B1eYyialFUnoZ0EzNWdWVjc3cUk ).

Installation

Two ways to find the Plugin

First way

Navigate to Extensions → Manage → Discover

Select the Plugin “plg_system_tour” and Install it.

Second way

Download the Plugin from the link mentioned above.
Select the Downloaded Plugin Folder and Install it.

Extension → Manage → Install

How to start the Guided Tour

Then enable the Plugin Extension → Plugin → plg_system_tour

Visit any View and you will find the button at the top right corner.
Click on it and you can enjoy the new feature of Joomla! 4.

Issues

Note: If there are any issues while attempting to set up the platform or any suggestions to the platform itself or to the documentation don't hesitate to drop an issue at the project's repository.

@@ Line 3: / Line 3: @@
 Guided Tour Project Documentation}}
 [[Image:Gsoc2016.png|75px|center|link=GSOC 2017]]
-<noinclude>{{Joomla version|version=3.x}}</noinclude>
+<noinclude>{{Joomla version|version=4.x}}</noinclude>
 {{-}}
@@ Line 15: / Line 15: @@
 * A Plugin of the Tour Guide ( https://drive.google.com/open?id=0B1eYyialFUnoZ0EzNWdWVjc3cUk ).
-== How to start the Guided Tour ==
+== Installation ==
 === Two ways to find the Plugin ===
-First way
-*Head to the <tt>Extension → Manage → Discover →</tt>
+==== First way ====
+*Navigate to '''Extensions {{rarr}} Manage {{rarr}} Discover'''
 [[File:J4-plugin discover-en.png|center]]
 *Select the Plugin “plg_system_tour” and Install it.
-[[File:J4-Discover_Plugin-en.png|center]]
+[[File:J4-Discover_Plugin-en.png|center|800px]]
----------------------------------------------------------------------------------------------------------------------
-Second way
+==== Second way ====
+*Download the Plugin from the link mentioned above.
+*Select the Downloaded Plugin Folder and Install it.
+'''Extension {{rarr}} Manage {{rarr}} Install
+[[File:J4-Install_Plugin-en.png|center|800px]]
+== How to start the Guided Tour ==
-*Install the Plugin from the link mentioned above.
+*Then enable the Plugin '''Extension {{rarr}} Plugin {{rarr}} plg_system_tour'''
-*First, enable the Plugin.
+[[File:J4-Plugin_Screenshot_Enable-en.png|center|800px]]
-*The Plugin “plg_system_tour” can be installed with the extension manager.
-<tt>Extension->Plugin->plg_system_tour</tt>
-[[File:J4-Plugin Screenshot Enable-en.png|center]]
 *Visit any View and you will find the button at the top right corner.
-*Click on it and you can enjoy the new feature of Joomla 4.
+*Click on it and you can enjoy the new feature of Joomla! 4.
-[[File:J4-Take_the_Tour_Button-en.png|left]]
+[[File:J4-Take_the_Tour_Button-en.png]]
+== Issues ==
+'''Note: If there are any issues while attempting to set up the platform or any suggestions to the platform itself or to the documentation don't hesitate to drop an issue at the [https://github.com/joomla-projects/gsoc17_helpscreens_on_jdocs project's repository].'''
 <noinclude>