Mercurial > emacs
comparison lisp/calendar/timeclock.el @ 92548:979f17a77d87
Remove leading `*' from defcustom doc-strings.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Fri, 07 Mar 2008 04:43:35 +0000 |
parents | 107ccd98fa12 |
children | 570c28579388 |
comparison
equal
deleted
inserted
replaced
92547:3c802ca7a7fa | 92548:979f17a77d87 |
---|---|
83 :group 'data) | 83 :group 'data) |
84 | 84 |
85 ;;; User Variables: | 85 ;;; User Variables: |
86 | 86 |
87 (defcustom timeclock-file (convert-standard-filename "~/.timelog") | 87 (defcustom timeclock-file (convert-standard-filename "~/.timelog") |
88 "*The file used to store timeclock data in." | 88 "The file used to store timeclock data in." |
89 :type 'file | 89 :type 'file |
90 :group 'timeclock) | 90 :group 'timeclock) |
91 | 91 |
92 (defcustom timeclock-workday (* 8 60 60) | 92 (defcustom timeclock-workday (* 8 60 60) |
93 "*The length of a work period." | 93 "The length of a work period." |
94 :type 'integer | 94 :type 'integer |
95 :group 'timeclock) | 95 :group 'timeclock) |
96 | 96 |
97 (defcustom timeclock-relative t | 97 (defcustom timeclock-relative t |
98 "*Whether to make reported time relative to `timeclock-workday'. | 98 "Whether to make reported time relative to `timeclock-workday'. |
99 For example, if the length of a normal workday is eight hours, and you | 99 For example, if the length of a normal workday is eight hours, and you |
100 work four hours on Monday, then the amount of time \"remaining\" on | 100 work four hours on Monday, then the amount of time \"remaining\" on |
101 Tuesday is twelve hours -- relative to an averaged work period of | 101 Tuesday is twelve hours -- relative to an averaged work period of |
102 eight hours -- or eight hours, non-relative. So relative time takes | 102 eight hours -- or eight hours, non-relative. So relative time takes |
103 into account any discrepancy of time under-worked or over-worked on | 103 into account any discrepancy of time under-worked or over-worked on |
104 previous days. This only affects the timeclock modeline display." | 104 previous days. This only affects the timeclock modeline display." |
105 :type 'boolean | 105 :type 'boolean |
106 :group 'timeclock) | 106 :group 'timeclock) |
107 | 107 |
108 (defcustom timeclock-get-project-function 'timeclock-ask-for-project | 108 (defcustom timeclock-get-project-function 'timeclock-ask-for-project |
109 "*The function used to determine the name of the current project. | 109 "The function used to determine the name of the current project. |
110 When clocking in, and no project is specified, this function will be | 110 When clocking in, and no project is specified, this function will be |
111 called to determine what is the current project to be worked on. | 111 called to determine what is the current project to be worked on. |
112 If this variable is nil, no questions will be asked." | 112 If this variable is nil, no questions will be asked." |
113 :type 'function | 113 :type 'function |
114 :group 'timeclock) | 114 :group 'timeclock) |
115 | 115 |
116 (defcustom timeclock-get-reason-function 'timeclock-ask-for-reason | 116 (defcustom timeclock-get-reason-function 'timeclock-ask-for-reason |
117 "*A function used to determine the reason for clocking out. | 117 "A function used to determine the reason for clocking out. |
118 When clocking out, and no reason is specified, this function will be | 118 When clocking out, and no reason is specified, this function will be |
119 called to determine what is the reason. | 119 called to determine what is the reason. |
120 If this variable is nil, no questions will be asked." | 120 If this variable is nil, no questions will be asked." |
121 :type 'function | 121 :type 'function |
122 :group 'timeclock) | 122 :group 'timeclock) |
123 | 123 |
124 (defcustom timeclock-get-workday-function nil | 124 (defcustom timeclock-get-workday-function nil |
125 "*A function used to determine the length of today's workday. | 125 "A function used to determine the length of today's workday. |
126 The first time that a user clocks in each day, this function will be | 126 The first time that a user clocks in each day, this function will be |
127 called to determine what is the length of the current workday. If | 127 called to determine what is the length of the current workday. If |
128 the return value is nil, or equal to `timeclock-workday', nothing special | 128 the return value is nil, or equal to `timeclock-workday', nothing special |
129 will be done. If it is a quantity different from `timeclock-workday', | 129 will be done. If it is a quantity different from `timeclock-workday', |
130 however, a record will be output to the timelog file to note the fact that | 130 however, a record will be output to the timelog file to note the fact that |
131 that day has a length that is different from the norm." | 131 that day has a length that is different from the norm." |
132 :type '(choice (const nil) function) | 132 :type '(choice (const nil) function) |
133 :group 'timeclock) | 133 :group 'timeclock) |
134 | 134 |
135 (defcustom timeclock-ask-before-exiting t | 135 (defcustom timeclock-ask-before-exiting t |
136 "*If non-nil, ask if the user wants to clock out before exiting Emacs. | 136 "If non-nil, ask if the user wants to clock out before exiting Emacs. |
137 This variable only has effect if set with \\[customize]." | 137 This variable only has effect if set with \\[customize]." |
138 :set (lambda (symbol value) | 138 :set (lambda (symbol value) |
139 (if value | 139 (if value |
140 (add-hook 'kill-emacs-query-functions 'timeclock-query-out) | 140 (add-hook 'kill-emacs-query-functions 'timeclock-query-out) |
141 (remove-hook 'kill-emacs-query-functions 'timeclock-query-out)) | 141 (remove-hook 'kill-emacs-query-functions 'timeclock-query-out)) |
149 ;; For byte-compiler. | 149 ;; For byte-compiler. |
150 (defvar display-time-hook) | 150 (defvar display-time-hook) |
151 (defvar timeclock-modeline-display) | 151 (defvar timeclock-modeline-display) |
152 | 152 |
153 (defcustom timeclock-use-display-time t | 153 (defcustom timeclock-use-display-time t |
154 "*If non-nil, use `display-time-hook' for doing modeline updates. | 154 "If non-nil, use `display-time-hook' for doing modeline updates. |
155 The advantage of this is that one less timer has to be set running | 155 The advantage of this is that one less timer has to be set running |
156 amok in Emacs' process space. The disadvantage is that it requires | 156 amok in Emacs' process space. The disadvantage is that it requires |
157 you to have `display-time' running. If you don't want to use | 157 you to have `display-time' running. If you don't want to use |
158 `display-time', but still want the modeline to show how much time is | 158 `display-time', but still want the modeline to show how much time is |
159 left, set this variable to nil. Changing the value of this variable | 159 left, set this variable to nil. Changing the value of this variable |
185 :type 'boolean | 185 :type 'boolean |
186 :group 'timeclock | 186 :group 'timeclock |
187 :require 'time) | 187 :require 'time) |
188 | 188 |
189 (defcustom timeclock-first-in-hook nil | 189 (defcustom timeclock-first-in-hook nil |
190 "*A hook run for the first \"in\" event each day. | 190 "A hook run for the first \"in\" event each day. |
191 Note that this hook is run before recording any events. Thus the | 191 Note that this hook is run before recording any events. Thus the |
192 value of `timeclock-hours-today', `timeclock-last-event' and the | 192 value of `timeclock-hours-today', `timeclock-last-event' and the |
193 return value of function `timeclock-last-period' are relative previous | 193 return value of function `timeclock-last-period' are relative previous |
194 to today." | 194 to today." |
195 :type 'hook | 195 :type 'hook |
196 :group 'timeclock) | 196 :group 'timeclock) |
197 | 197 |
198 (defcustom timeclock-load-hook nil | 198 (defcustom timeclock-load-hook nil |
199 "*Hook that gets run after timeclock has been loaded." | 199 "Hook that gets run after timeclock has been loaded." |
200 :type 'hook | 200 :type 'hook |
201 :group 'timeclock) | 201 :group 'timeclock) |
202 | 202 |
203 (defcustom timeclock-in-hook nil | 203 (defcustom timeclock-in-hook nil |
204 "*A hook run every time an \"in\" event is recorded." | 204 "A hook run every time an \"in\" event is recorded." |
205 :type 'hook | 205 :type 'hook |
206 :group 'timeclock) | 206 :group 'timeclock) |
207 | 207 |
208 (defcustom timeclock-day-over-hook nil | 208 (defcustom timeclock-day-over-hook nil |
209 "*A hook that is run when the workday has been completed. | 209 "A hook that is run when the workday has been completed. |
210 This hook is only run if the current time remaining is being displayed | 210 This hook is only run if the current time remaining is being displayed |
211 in the modeline. See the variable `timeclock-modeline-display'." | 211 in the modeline. See the variable `timeclock-modeline-display'." |
212 :type 'hook | 212 :type 'hook |
213 :group 'timeclock) | 213 :group 'timeclock) |
214 | 214 |
215 (defcustom timeclock-out-hook nil | 215 (defcustom timeclock-out-hook nil |
216 "*A hook run every time an \"out\" event is recorded." | 216 "A hook run every time an \"out\" event is recorded." |
217 :type 'hook | 217 :type 'hook |
218 :group 'timeclock) | 218 :group 'timeclock) |
219 | 219 |
220 (defcustom timeclock-done-hook nil | 220 (defcustom timeclock-done-hook nil |
221 "*A hook run every time a project is marked as completed." | 221 "A hook run every time a project is marked as completed." |
222 :type 'hook | 222 :type 'hook |
223 :group 'timeclock) | 223 :group 'timeclock) |
224 | 224 |
225 (defcustom timeclock-event-hook nil | 225 (defcustom timeclock-event-hook nil |
226 "*A hook run every time any event is recorded." | 226 "A hook run every time any event is recorded." |
227 :type 'hook | 227 :type 'hook |
228 :group 'timeclock) | 228 :group 'timeclock) |
229 | 229 |
230 (defvar timeclock-last-event nil | 230 (defvar timeclock-last-event nil |
231 "A list containing the last event that was recorded. | 231 "A list containing the last event that was recorded. |