Plugin Directory

Changeset 1272366


Ignore:
Timestamp:
10/24/2015 05:52:00 PM (10 years ago)
Author:
antrouss
Message:

upgrade to 1.1 (fixed some bugs)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • unitimetable/trunk/readme.txt

    r1272352 r1272366  
    22Contributors: antrouss, kokkoras
    33Donate link: -
    4 Tags: timetable, curriculum, calendar, lessons, subjects, lectures
    5 Requires at least: 4.2
    6 Tested up to: 4.2.2
    7 Stable tag: 1.0
     4Tags: timetable, calendar, lectures
     5Requires at least: 4.0
     6Tested up to: 4.3
     7Stable tag: 1.1
    88License: GPLv2
    99License URI: http://www.gnu.org/licenses/gpl-2.0.html
    1010
    11 UniTimetable enables you to insert periods,teachers,subjects, student groups, classrooms, holidays, events and lectures, in order to create a timetable for a department. The plugin enables you to show this timetable to a site, using shortcodes.
     11UniTimetable creates timetables for educational institutes. Display lecturing and usage timetables for teachers, semesters, labs, etc.
    1212
    1313== Description ==
    14 UniTimetable is a WordPress plugin for presenting timetables of an educational institute. It includes teachers, classrooms, subjects (modules) and student groups, which are all combined to define lectures. The lectures can be scheduled at some time point during a semester. Out of schedule events and holidays are also supported. After providing the plugin with data, shortcodes provided generate beautiful calendars with all or selected part of the entered data. UniTimetable was designed by Fotis Kokkoras and Antonis Roussos and implemented by Antonis Roussos for the fulfillment of his BSc Thesis in the Department of Computer Science and Engineering (TEI of Thessaly, Greece).
     14**UniTimetable** is a WordPress plugin for presenting timetables of an educational institute. It includes teachers, classrooms, subjects (modules) and student groups, which are all combined to define lectures. The lectures can be scheduled at some time point during a semester. Out of schedule events and holidays are also supported.
     15After providing the plugin with data, shortcodes provided generate beautiful calendars with all or selected part of the entered data.
     16
     17UniTimetable was designed by **Fotis Kokkoras** and **Antonis Roussos** and implemented by Antonis Roussos for the fulfillment of his BSc Thesis in the **Department of Computer Science and Engineering**, at **TEI of Thessaly**, Greece.
     18
    1519
    1620== Installation ==
    17 
    18 Upload UniTimetable to your site and activate it.
     211. Upload the entire UniTimetable folder to the `/wp-content/plugins/` directory.
     222. Activate the plugin through the `Plugins` menu in WordPress.
     233. Find `UniTimeTable` menu in your WordPress admin panel and use the forms provided for data entry.
    1924
    2025How to use the Shortcodes:
    21 The general purpose shortcode is [utt_calendar] and should be better placed in a page (or post) with substantial width. The resulting calendar includes two filter combo-boxes for selecting individual calendars for any of the semester, classroom, and teacher.
    22 In case that a fixed calendar is required, parameters can be added to precisely define the content to be displayed. More specifically:
    23     [utt_calendar classroom = <comma separated classroomID list>] (examples: [utt_calendar classroom=1], [utt_calendar classroom=1,2,3])
    24     [utt_calendar teacher = <comma separated teacherID list>]
    25     [utt_calendar semester = <comma separated semester list>]
    26 Note that the filtered shortcodes generate a calendar without the usual filter combo-boxes.
     26
     27The general purpose shortcode is `[utt_calendar]` and should be better placed in a page (or post) with substantial width (the calendar is responsive though and fits everywhere). The resulting calendar includes two filter drop-down lists for the end-user to select individual calendars for any of the semester, classroom, or teacher.
     28In case that a fixed calendar is required (without drop down filters), parameters can be added to precisely define the content to be displayed. Three parameters are supported: classroom, teacher and semester. Here are some examples:
     29
     30* `[utt_calendar classroom=1]` will display the schedule of classroom with ID=1.
     31* `[utt_calendar classroom=1,2,3]` will display the schedule of classrooms with IDs 1, 2 and 3.
     32* `[utt_calendar teacher = 12]` will display the lecturing program of teacher with ID 12.
     33* `[utt_calendar semester = 2]` will display the lecturing program of the semester with ID 2.
     34
     35**Note:** *You can locate the IDs required in the corresponding forms in the UnitimeTable admin page. Comma separated IDs are supported in all cases.*
     36
     37
     38== Screenshots ==
     391. Resulting timetable with filtering drop-down lists (the example data are in Greek).
     402. The main admin page of the plugin.
     413. Form for managing subjects (the example data are in Greek).
     424. Lecture management form. You can create multiple entries for successive weeks with a single insert, by defining the `number of weeks` value (for example, if you want to schedule Algebra for the next 13 weeks).
     435. The calendar as seen from the lecture management form (the example data are in Greek). Note the delete and edit buttons in each entry.
     44
    2745
    2846== Changelog ==
    2947
    3048= 1.0 =
    31 * Periods management
    32 * Teachers management
    33 * Subjects management
    34 * Classrooms management
    35 * Groups management
    36 * Holidays management
    37 * Events management
    38 * Lectures management
    39 * [utt_calendar] shortcode
     49Initial Release
    4050
    4151= 1.1 =
     
    4555* Fixed problem with Lectures deletion and edit
    4656
     57
     58== Translations ==
     59* English - default, always included
     60* Greek - default, always included
     61
     62*Note:* Translations refer to the user interface (admin panel and calendar). All the content will be always displayed in the language inserted. You can not translate a timetable. If desired so, the only way is to build a new calendar in another language.
     63
Note: See TracChangeset for help on using the changeset viewer.