~ubuntu-branches/ubuntu/raring/webcalendar/raring

« back to all changes in this revision

Viewing changes to docs/README

  • Committer: Bazaar Package Importer
  • Author(s): Rafael Laboissiere
  • Date: 2009-06-09 06:26:24 UTC
  • mfrom: (18.2.3 karmic)
  • Revision ID: james.westby@ubuntu.com-20090609062624-9n9xea2ftpipmg38
Tags: 1.2.0+dfsg-4
* debian/patches/06_send-reminder-paths.diff: Adjust patch to help
  translate.php to find the translation files under /etc/webcalendar.
  Thanks to Dale and Cheryl Schroeder for the help on debugging this
  (really, closes: #531312).
* debian/patches/16_no-blink-public-access-title.diff: New patch for
  avoiding the blinking title when changing the Public Access title in
  English-US.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
WebCalendar Documentation
2
 
-------------------------------------------------------------
3
 
 
4
 
WebCalendar-Database.html
5
 
  Describes the database tables in WebCalendar
6
 
  Can be regenerated (if you have perl and make installed) by typing "make".
7
 
 
8
 
WebCalendar-UserManual.html
9
 
  Instructions for end users
10
 
 
11
 
WebCalendar-SysAdmin.html
12
 
  Instructions for system administrators on installing and configuring
13
 
  WebCalendar
14
 
 
15
 
WebCalendar-DeveloperGuide.html
16
 
  Guidelines for developers wanting to make changes to WebCalendar
17
 
 
18
 
WebCalendar-Functions.html
19
 
  Documentation on the internal WebCalendar functions used throughout
20
 
  the application
21
 
  Can be regenerated (if you have perl and make installed) by typing "make".
22
 
 
23
 
faqs.html
24
 
  This is generated from the FAQs of in WebCalendar-SysAdmin.html and
25
 
  WebCalendar-UserManual.html.  If you have perl and make,
26
 
  typing "make" should generate this file.  This file is not a complete
27
 
  HTML file.  It is intended to be inserted into the body of another
28
 
  HTML page.  You can see it in use at:
29
 
    http://www.k5n.us/webcalendar.php?topic=FAQ
30
 
 
31
 
 
32
 
Tools
33
 
-------------------------------------------------------------
34
 
 
35
 
sql2html.pl
36
 
  Perl tool to generate documentation on the database structure
37
 
  (WebCalendar-Database.html) using comments found in tables-mysql.sql.
38
 
 
39
 
php2html.pl
40
 
  Perl tool to generate documentation (somewhat like javadoc) on
41
 
  internal WebCalendar functions (WebCalendar-Functions.html) using
42
 
  the comments found in the PHP code.
43
 
 
44
 
extractfaqs.pl
45
 
  Perl tool to pull the FAQs out of the documentation to create one
46
 
  set of FAQs that can be included in another HTML page.  (This is used
47
 
  to create a single FAQ page on the WebCalendar home page.)
48
 
 
49
 
Makefile
50
 
  Used by the 'make' command to create files that are generated from
51
 
  other files.
52
 
 
53