Updated some docs

craigk5n · Jun 27, 2017 · 2178b46 · 2178b46
1 parent 9fbf142
commit 2178b46
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 WebCalendar README
 ------------------
 
-Project Home Page: http://www.k5n.us/webcalendar.php
-Project Owner: Craig Knudsen, &#99;&#114;&#97;&#105;&#103;&#64;&#107;&#53;&#110;&#46;&#117;&#115;
+Project Home Page: http://www.k5n.us/webcalendar.php  
+Project Owner: Craig Knudsen, &#99;&#114;&#97;&#105;&#103;&#64;&#107;&#53;&#110;&#46;&#117;&#115;  
 Documentation:
 - [System Administrator's Guide](http://htmlpreview.github.io/?https://github.com/craigk5n/webcalendar/blob/master/docs/WebCalendar-SysAdmin.html) (Installation instructions, FAQ)
 - [Upgrading Instructions](http://htmlpreview.github.io/?https://github.com/craigk5n/webcalendar/blob/master/UPGRADING.html)

diff --git a/docs/WebCalendar-Database.html b/docs/WebCalendar-Database.html
@@ -47,7 +47,7 @@ <h2>WebCalendar Database Documentation</h2>
         <a href="http://www.k5n.us/webcalendar.php">http://www.k5n.us/webcalendar.php</a></p>
       <p><label>Author:</label><a href="http://www.k5n.us">Craig Knudsen</a>,
         <a href="mailto:&#109;&#097;&#105;&#108;&#116;&#111;&#058;&#67;&#114;&#97;&#105;&#103;&#64;&#107;&#53;&#110;&#46;&#117;&#115;">&#67;&#114;&#97;&#105;&#103;&#64;&#107;&#53;&#110;&#46;&#117;&#115;</a></p>
-      <p></p><label>Version:</label>Unknown Version, &nbsp; $Id: WebCalendar-Database.html,v 1.26 2007/08/04 05:10:20 cknudsen Exp $</p>
+      <p></p><label>Version:</label>1.3 Development, &nbsp; $Id$</p>
     </div>
     <blockquote>
       <p>This file is generated from <tt>tables-mysql.sql</tt>. Below are the
@@ -96,7 +96,7 @@ <h2>List of Tables</h2>
 
     <h3><a name="webcal_access_function">webcal_access_function</a></h3>
     <blockquote>
-
+      *
       Specifies what WebCalendar functions a user can access.  Each function
       has a corresponding numeric value (specified in the file
       includes/access.php).  For example, view event is 0, so the very first
@@ -134,7 +134,7 @@ <h3><a name="webcal_access_function">webcal_access_function</a></h3>
 
     <h3><a name="webcal_access_user">webcal_access_user</a></h3>
     <blockquote>
-
+      *
       Specifies which users can access another user's calendar.
       <br /><br />
       <table summary="Schema for table webcal_access_user">
@@ -216,7 +216,7 @@ <h3><a name="webcal_access_user">webcal_access_user</a></h3>
 
     <h3><a name="webcal_asst">webcal_asst</a></h3>
     <blockquote>
-
+      *
       Define assitant/boss relationship.
       <br /><br />
       <table summary="Schema for table webcal_asst">
@@ -250,7 +250,7 @@ <h3><a name="webcal_asst">webcal_asst</a></h3>
 
     <h3><a name="webcal_blob">webcal_blob</a></h3>
     <blockquote>
-
+      *
       This table stores event attachments and comments.
       <br /><br />
       <table summary="Schema for table webcal_blob">
@@ -356,7 +356,7 @@ <h3><a name="webcal_blob">webcal_blob</a></h3>
 
     <h3><a name="webcal_categories">webcal_categories</a></h3>
     <blockquote>
-
+      *
       Defines user categories.  Categories can be specific to a user or global.
       When a category is global, the cat_owner field will be NULL.
       (Only an admin user can create a global category.)
@@ -408,7 +408,7 @@ <h3><a name="webcal_categories">webcal_categories</a></h3>
 
     <h3><a name="webcal_config">webcal_config</a></h3>
     <blockquote>
-
+      *
       System settings (set by the admin interface in admin.php)
       <br /><br />
       <table summary="Schema for table webcal_config">
@@ -442,7 +442,7 @@ <h3><a name="webcal_config">webcal_config</a></h3>
 
     <h3><a name="webcal_entry">webcal_entry</a></h3>
     <blockquote>
-
+      *
       Defines a calendar event.  Each event in the system has one entry in
       this table unless the event starts before midnight and ends after
       midnight. In that case a secondary event will be created with
@@ -632,7 +632,7 @@ <h3><a name="webcal_entry">webcal_entry</a></h3>
 
     <h3><a name="webcal_entry_categories">webcal_entry_categories</a></h3>
     <blockquote>
-
+      *
       Contains category foreign keys
       to enable multiple categories for each event or task
       <br /><br />
@@ -683,7 +683,7 @@ <h3><a name="webcal_entry_categories">webcal_entry_categories</a></h3>
 
     <h3><a name="webcal_entry_ext_user">webcal_entry_ext_user</a></h3>
     <blockquote>
-
+      *
       This table associates one or more external users (people who do not
       have a WebCalendar login) with an event by the event id.  An event must
       still have at least one WebCalendar user associated with it.  This table
@@ -729,7 +729,7 @@ <h3><a name="webcal_entry_ext_user">webcal_entry_ext_user</a></h3>
 
     <h3><a name="webcal_entry_log">webcal_entry_log</a></h3>
     <blockquote>
-
+      *
       Activity log for an event.
       <br /><br />
       <table summary="Schema for table webcal_entry_log">
@@ -818,7 +818,7 @@ <h3><a name="webcal_entry_log">webcal_entry_log</a></h3>
 
     <h3><a name="webcal_entry_repeats">webcal_entry_repeats</a></h3>
     <blockquote>
-
+      *
       Defines repeating info about an event.
       The event is defined in <a href="#webcal_entry">webcal_entry</a>.
       <br /><br />
@@ -956,7 +956,7 @@ <h3><a name="webcal_entry_repeats">webcal_entry_repeats</a></h3>
 
     <h3><a name="webcal_entry_repeats_not">webcal_entry_repeats_not</a></h3>
     <blockquote>
-
+      *
       This table specifies which dates in a repeating event have either been
       deleted, included, or replaced with a replacement event for that day.
       When replaced, the cal_group_id (I know... not the best name, but it
@@ -1003,7 +1003,7 @@ <h3><a name="webcal_entry_repeats_not">webcal_entry_repeats_not</a></h3>
 
     <h3><a name="webcal_entry_user">webcal_entry_user</a></h3>
     <blockquote>
-
+      *
       This table associates one or more users with an event by the event id.
       The event can be found in <a href="#webcal_entry">webcal_entry</a>.
       <br /><br />
@@ -1069,7 +1069,7 @@ <h3><a name="webcal_entry_user">webcal_entry_user</a></h3>
 
     <h3><a name="webcal_group">webcal_group</a></h3>
     <blockquote>
-
+      *
       Define a group.  Group members can be found in
       <a href="#webcal_group_user">webcal_group_user</a>.
       <br /><br />
@@ -1120,7 +1120,7 @@ <h3><a name="webcal_group">webcal_group</a></h3>
 
     <h3><a name="webcal_group_user">webcal_group_user</a></h3>
     <blockquote>
-
+      *
       Specify users in a group.  The group is defined in
       <a href="#webcal_group">webcal_group</a>.
       <br /><br />
@@ -1155,7 +1155,7 @@ <h3><a name="webcal_group_user">webcal_group_user</a></h3>
 
     <h3><a name="webcal_import">webcal_import</a></h3>
     <blockquote>
-
+      *
       Used to track import data (one row per import)
       <br /><br />
       <table summary="Schema for table webcal_import">
@@ -1213,7 +1213,7 @@ <h3><a name="webcal_import">webcal_import</a></h3>
 
     <h3><a name="webcal_import_data">webcal_import_data</a></h3>
     <blockquote>
-
+      *
       Used to track import data (one row per event)
       <br /><br />
       <table summary="Schema for table webcal_import_data">
@@ -1271,7 +1271,7 @@ <h3><a name="webcal_import_data">webcal_import_data</a></h3>
 
     <h3><a name="webcal_nonuser_cals">webcal_nonuser_cals</a></h3>
     <blockquote>
-
+      *
       Defines non-user calendars.
       <br /><br />
       <table summary="Schema for table webcal_nonuser_cals">
@@ -1337,7 +1337,7 @@ <h3><a name="webcal_nonuser_cals">webcal_nonuser_cals</a></h3>
 
     <h3><a name="webcal_reminders">webcal_reminders</a></h3>
     <blockquote>
-
+      *
       Stores information about reminders
       <br /><br />
       <table summary="Schema for table webcal_reminders">
@@ -1435,7 +1435,7 @@ <h3><a name="webcal_reminders">webcal_reminders</a></h3>
 
     <h3><a name="webcal_report">webcal_report</a></h3>
     <blockquote>
-
+      *
       Defines a custom report created by a user.
       <br /><br />
       <table summary="Schema for table webcal_report">
@@ -1578,7 +1578,7 @@ <h3><a name="webcal_report">webcal_report</a></h3>
 
     <h3><a name="webcal_report_template">webcal_report_template</a></h3>
     <blockquote>
-
+      *
       Defines one of the templates used for a report.
       Each report has three templates:
       <ol>
@@ -1658,7 +1658,7 @@ <h3><a name="webcal_report_template">webcal_report_template</a></h3>
 
     <h3><a name="webcal_site_extras">webcal_site_extras</a></h3>
     <blockquote>
-
+      *
       This table holds data for site extra fields
       (customized in site_extra.php).
       <br /><br />
@@ -1725,6 +1725,7 @@ <h3><a name="webcal_site_extras">webcal_site_extras</a></h3>
 
     <h3><a name="webcal_timezones">webcal_timezones</a></h3>
     <blockquote>
+      ** This table stores timezones of the world.
       <br /><br />
       <table summary="Schema for table webcal_timezones">
         <tr>
@@ -1773,7 +1774,7 @@ <h3><a name="webcal_timezones">webcal_timezones</a></h3>
 
     <h3><a name="webcal_user">webcal_user</a></h3>
     <blockquote>
-
+      *
       Defines a WebCalendar user.
       <br /><br />
       <table summary="Schema for table webcal_user">
@@ -1887,7 +1888,7 @@ <h3><a name="webcal_user">webcal_user</a></h3>
 
     <h3><a name="webcal_user_layers">webcal_user_layers</a></h3>
     <blockquote>
-
+      *
       Define layers for a user.
       <br /><br />
       <table summary="Schema for table webcal_user_layers">
@@ -1945,7 +1946,7 @@ <h3><a name="webcal_user_layers">webcal_user_layers</a></h3>
 
     <h3><a name="webcal_user_pref">webcal_user_pref</a></h3>
     <blockquote>
-
+      *
       Specify preferences for a user.
       Most preferences are set via pref.php.
       Values in this table are loaded after system settings
@@ -1990,7 +1991,7 @@ <h3><a name="webcal_user_pref">webcal_user_pref</a></h3>
 
     <h3><a name="webcal_user_template">webcal_user_template</a></h3>
     <blockquote>
-
+      *
       This table stores the custom header/stylesheet/trailer.  If configured
       properly, each user (or nonuser cal) can have their own custom
       header/trailer.
@@ -2034,7 +2035,7 @@ <h3><a name="webcal_user_template">webcal_user_template</a></h3>
 
     <h3><a name="webcal_view">webcal_view</a></h3>
     <blockquote>
-
+      *
       A "view" allows a user to put the calendars of multiple users all on one
       page.  A "view" is valid only for the owner (cal_owner) of the view.
       Users for the view are in
@@ -2095,7 +2096,7 @@ <h3><a name="webcal_view">webcal_view</a></h3>
 
     <h3><a name="webcal_view_user">webcal_view_user</a></h3>
     <blockquote>
-
+      *
       Specify users in a view. See <a href="#webcal_view">webcal_view</a>.
       <br /><br />
       <table summary="Schema for table webcal_view_user">