1===== Navigation =====
2
3
4~~CLOSE~~
5
6
7The navigation links in the Navigation Bar at the top are toggles.  Clicking them opens the appropriate window, clicking a second time closes it. The windows stay open until toggled shut.
8
9
10The **Help** links at the top of the function windows are also toggles and link to the relevant sections of this page.
11
12
13Whether you open this window from the navigation bar or from the function window, you can always close it by clicking on either **Help** link
14
15
16The **Close All** link in the Navigation Bar will close all windows but the Message Area.
17===== Update/Create SQL Database =====
18
19
20~~CLOSE~~
21
22
23This window has three functions
24
25
26    - Initialize Sqlite Database
27    - Update Database
28    - Set  URL of Remote Repository
29
30
31Both of the first two take dates from which the updating or DB creation starts.  Initializing deletes all the data and starts all over again at the  new date.  Updating inserts new data into the database starting at the specified date.  When you start your database for the first time, the database structure is already set up and you can select either Update Database or Initialize Sqlite Database.  But after your database contains data, you will want to use Update.
32
33
34===== Update Git =====
35
36
37~~CLOSE~~
38
39
40This window is for updating the git.  You can check the current status of the git and pull in any new commits from gitHub.
41
42
43The URL of the Remote Repository is needed to create links to the commits on the gitHub (or any git) web site.  Normally, dwcommits can retrieve the URL from the local git repository when you click on the "Get Remote URL " button.  To save the URL, click on the "Save Remote URL "button.
44
45
46If the URL appears in the text box, then the URL has already been saved. You can, however, edit it this URL at any time and re-save it.
47
48
49==== Web Server Access ====
50
51
52To  be able to update a git from the web browser, you may have to create a separate ssh key for the web server. To do this, you will very likely need root access.  The procedure is as follows:
53
54
55<code>
56   sudo -u apache  ssh-keygen -t rsa -C your_email@whatever.org
57</code>
58
59
60You will be asked where to store you ssh key files.  On linux servers, this defaults to /var/www, which is the "home" directory for apache.  Once you have done this, you can then clone repositories as the web server.  For instance:
61
62
63<code>
64     sudo -u apache  git clone git@github.com:turnermm/fckgLite
65</code>
66
67
68With this in  place you can use the "pull" function in the admin panel.   Otherwise, you may have to update your gits from the command line, using your own identity.  However, you must give the web server read/write access to the local repository nevertheless.
69
70
71===== Advanced Git Options =====
72
73
74~~CLOSE~~
75
76
77These functions enable you to fetch new data from github, then to merge this data into your git. These two steps are combined in the pull function of the **Update Git**  window. In this window, you can also add and commit files which you may have added locally and have not uploaded to gitHub.
78
79
80===== Repos/Branches =====
81
82
83~~CLOSE~~
84
85
86In this window you can change the current git and switch to another branch of the current git.
87
88
89===== Query =====
90
91
92~~CLOSE~~
93
94
95There are six fields: Term 1, Term 2, Author, Branch, Start Date, End Date.
96
97
98You can search for Term 1, for Term 1 AND/OR Term 2, for  Author, AND/Or  Author. You can restrict your search to the selected Branch and to commits made after Start Date, before End Date,  or between Start Date and End Date.   You can select any one or combination of these six fields.
99
100
101The Term and Author search is   "fuzzy" and case insensitive.  If you are looking for an author named ''John Jackson'', you can enter simply ''jack''  in the Author field.
102
103
104===== Maintenance =====
105
106
107~~CLOSE~~
108
109
110The maintenance panel enables deletion of unused database items.   There are three submit options:
111
112
113    - Prune Entries
114    - Delete Entries
115    - and Restore Backup
116
117
118Clicking on Prune Entries will delete the entry for this git from the dwcommits records, which are kept in db/dbnames.ser.  Clicking Delete Entries will delete the dwcommit record from db/dbnames.ser and also delete the sqlite database file for this entry, which is kept in data/meta.  The sqlite dtabase files all have this format: dwcommits_<n>.sqlite, where <n> is the number of its record in db/dbnames.ser.
119
120
121The last option is Restore Backup.  Whenever you delete or prune an item, the maintenance software saves a backup file of the previous record set, which is saved in db/dbnames.ser.prev.  If you decide to go back to the previous set of records, then you can click on this button; it cannot, however, restore any sqlite database files which  you have deleted.  So, if you use Delete Entries and then Restore Backup, you will have to recreate your sqlite database.
122
123
124The Restore Backup is simply a temporary band-aid, primarily useful during the current session, in case you to make an error.  If you add a new entry to dbnames.ser and then restore the old backup, the new record will be lost.
125