July 13, 2012

Guide to Tutorial Viewers for Purchasers

Instructions/Guides | Written By Sean
Share on FacebookTweet about this on TwitterShare on LinkedInShare on Google+Email this to someone

1) What is the Tutorial Viewer?
The Tutorial Viewer is a tool we offer to all our clients, free of charge, that makes it easy for you to add a list of your tutorials to your website. There are two versions of this tool: the Dynamic version, which requires PHP 5.2 or higher to be installed on your server, and the Static version, which is just plain HTML and has no special requirements. We prefer the Dynamic version, and it is by far the most widely used version of the Tutorial Viewer. The Static version of the viewer does NOT support the MP4 and Text/Image formats; only SWF is supported at this time.

Don’t want to mess with setting up the Tutorial Viewer or integrating the script yourself? Our Integration Service has you covered!

2) Creating a Tutorial Viewer
Tutorial Viewers are created independently of your orders, so if you place multiple orders you can easily display ALL tutorials within your viewer, not just the ones from a single order. To create a Tutorial Viewer, click the Manage Tutorial Viewers link at the top of the My Purchases page, then click New Tutorial Viewer.

By default, the Tutorial Viewer will display ALL the tutorials you’ve purchased, but the “Which Tutorials to Display” option combined with the “Assign to Domain” feature next to every order lets you create viewers displaying different tutorials on different websites.

There are a number of Display Options that change the layout of the tutorials. You’ll find a preview of all the different Display Options here.

The Dynamic Run Mode is a setting that only applies to the Dynamic viewer. Which one you should use is dependent upon how you plan to integrate our Viewer with your website. If you use WHMCS, Kayako, or WordPress, you’ll find guides detailing how to integrate with these scripts here, as well as a guide on how to integrate using basic PHP.

You can also approach the integration from a different direction and instead customize the templates/tutorials.tpl file, adding your site’s header and footer HTML, in which case you’d leave the viewer set to Standalone mode.

The field labelled Static Version – Demo Path only applies to the Static version, and allows you to enter a URL or relative path to the folder containing your tutorial files. For example, if you plan to upload your Tutorial Viewer to viewer/ and your tutorial files to a subfolder named tutorials/, you would enter tutorials/ here.

The final option when creating a Tutorial Viewer allows you to choose which formats of tutorials to display in your viewer. This ONLY applies to the Dynamic viewer, since the Static viewer does NOT support any formats other than SWF at this time.

3) Installing Your Tutorial Viewer
Once you’ve created a Tutorial Viewer, when you return to the Manage Tutorial Viewers page you’ll see a link titled Download Tutorial Viewer. Download and extract this ZIP file, and upload all the files it contains to a NEW folder on your server (you could call it viewer/, or whatever you like).

3a) Extra Notes for the DYNAMIC Tutorial Viewer
When you first access the Tutorial Viewer in your browser, the script will attempt to auto-rename the includes/conf.new.php file to conf.php, but if this fails you will need to manually rename the file.

The Dynamic Tutorial Viewer will expect the tutorial files to be in a subfolder named tutorials/ by default, but you can change this by editing the $_CONF[‘demo_path’] and $_CONF[‘demo_uri’] values in the includes/conf.php file.

4) Uploading Your Tutorial Files
When your tutorials have finished generating and you can download them, extract those ZIP files to your computer. You will need to upload the series folders to your server to the following locations, depending on the format of the files:

  • Series folders for SWF files should go in tutorials/
  • Series folders for MP4 files should go in tutorials/mp4/
  • Series folders for Text/Image HTML files should go in tutorials/html/
  • Series folders for Text/Image image files should go in tutorials/images/

Any remaining questions? Please don’t hesitate to open a support ticket!

Share on FacebookTweet about this on TwitterShare on LinkedInShare on Google+Email this to someone