back to main

Progress-O-Meter plugin for Xcomic (v0.1.0)

plugin by mykaDragonBlue

Installation

Installation is a simple process:

NOTE: before installing this plugin you should run the Xcomic Plugin Enabler provided with the plugin files. From your Browser open Path_To_Xcomic/progressometer/fixForPlugins.php to fix a few bugs in the CVS version of Xcomic

  1. Extract the contents of the archive containing the current version of the progressometer plugin to the root directory of your Xcomic system.
  2. Go into the administration->plugins section of your Xcomic system. You should see an entry for "Progress-O-Meter vX.X.X". Use the option on the right to Install the Plugin. The plugins instalation process will copy a few required files to their correct locations, as well as setting up some stuff in the database.
  3. Make Sure to 'Activate' the plugin in administration->plugins after it has sucessfully installed. This is not done automatically.
  4. various functions of this plugin may require additional modifications to your theme files. See the sections regarding accessing the functionality of particular components of the plugin.

Functionality provided by this plugin

Progress Bar

  • plugin section allows a simple call to retrieve a 'next comic status' bar
  • Admin section allows for setting the progress
  • Admin section allows for the settign of colors for the status bar

NOTE: you will recieve errors if you have added a call to the plugin to your theme, but the plugin is currently inactive

Eventually I hope to allow multiple progress bars for use in different places in Xcomic

How to use the functions provided by this plugin:

Progress-O-Meter
  • Setting Current Progress

    Before an avatar can be uesd by a user it must be uploaded to the server. Go to the Progress-O-Meter page in the Administration section of Xcomic. below the display of avatars currently on the server is a file selection box that can be used to chose a new Avatar to upload from your local computer. once you have selected a file, press the 'Upload It' button and guess what should happen...

  • Changing the colors of the Progress-O-Meter

    In the Progress-O-Meter section of the Xcomic Administration panel, find the user you want to assign an Avatar to in the 'Users Avatars' table. click on the 'Edit' button at the right to go to the Avatar selection page. When in the Avatar Selection Page, simply click on one of the available Avatars to assign it to the current user.

  • Using the Progress-O-Meter in Xcomic

    In order to display a progress bar in Xcomic, you must edit the theme you are using. where you want the progress bar to be displayed. This will output an <img /> tag with class="avatar" (for use with css). Adding the appropriate section you theme's css file should allow you to appropriatly format the display of an avatar.

    Optionaly, you can use <?php out('getLinkToAvatar'); ?> if you want to return only the file path of the relevant avatar. This call will output something like avatar/filename.ext so that you can apply your own image tag in the theme.

  • Styling the Progress-O-Meter

    to gain the most functionality from the Progress-O-Meter, you will want to add you own styles to determine how it is displayed. To do this you will have to edit your theme's css file. (xc-themes/Theme_Name/style.css)

    • .progressometer -this is the progress bar as a whole. making changes to this styly will let you set overall borders (including the text if used) and let you style the text representation of current progress if it is in use. DO NOTattempt to set width and height characteristics for the progressbar using this style. Instead use .progressBg below.
    • .progressBg -this is the background section of the progress bar. Setting a height and width for this element will set the height and width for the progress bar as a whole.
    • .progressBar -this is the forground section of the status bar. you should not need to make any changes to this style.