1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 """
20 All help pages for the help system.
21
22 Template for translator comments (should be before all body parts):
23
24 # TRANSLATORS: This text uses special markup.
25 # DON'T translate 'HelpFigure(..)' or 'Help(..)'.
26 # Just write them as they are.
27 # Stars produce emphasized text. DON'T remove them.
28 # Dashes produce bullet lists. DON'T remove them.
29 """
30
31
33
34 help_system.install_page(
35 page_id="contents",
36 header=_("Help contents"),
37 body=("""
38 - **%s**
39 - Help(where_is_save)
40 - Help(categories_delete)
41 - Help(why_not_timeline_in_my_language)
42 - Help(week_numbers_sunday_week_start)
43 - Help(multiple_users)
44 - Help(check_all_categories)
45 - **%s**
46 - Help(timeline)
47 - Help(era)
48 - Help(events)
49 - Help(milestones)
50 - Help(categories)
51 - Help(experimental_features)
52 - Help(event_containers)
53 - **%s**
54 - Help(create_event)
55 - Help(edit_event)
56 - Help(move_event_vertically)
57 - Help(delete_event)
58 - Help(edit_categories)
59 - Help(select_events)
60 - Help(import_timeline)
61 - Help(undo_action)
62 - **Help(contact)**
63 """ % (_("Questions and answers"), _("Concepts"), _("Tasks"))))
64
65 help_system.install_page(
66 page_id="where_is_save",
67 header=_("Where is the save button?"),
68
69
70
71
72
73 body=_("""
74 There is no save button. Timeline will automatically save your data whenever needed.
75 """))
76
77 help_system.install_page(
78 page_id="week_numbers_sunday_week_start",
79 header=_("Where do the week numbers go if I start my weeks on Sunday?"),
80
81
82
83
84
85 body=_("""
86 The date data object used does not support week numbers for weeks that start on Sunday at present. We plan on using a different date object that will support this in future versions.
87 """))
88
89 help_system.install_page(
90 page_id="multiple_users",
91 header=_("Can multiple users work with the same timeline?"),
92
93
94
95
96
97 body=_("""
98 There are some support for multiple users to work on the same timeline file.
99
100 When you try to make a change and someone else has made a change you will be asked to make one of two choices:
101
102 - Set timeline in read-only mode.
103 - Synchronize the timeline.
104
105 During the your edit action the timeline is locked for changes by others. If you try to edit a timeline when it is locked by someone else you will be notified about this situation.
106 """))
107
108 help_system.install_page(
109 page_id="check_all_categories",
110 header=_("Can I Check or Uncheck all categories?"),
111 related_pages=["categories", "edit_categories"],
112
113
114
115
116
117 body=_("""
118 Yes you can check or uncheck all categories as well as a lot of other selection alternatives.
119
120 Make sure the categories pane is visible and then right-click with the mouse in the pane.
121 A context menu will now show up with all the check/uncheck alternatives available.
122
123 """))
124
125 help_system.install_page(
126 page_id="timeline",
127 header=_("Timeline"),
128 related_pages=["scrolling", "zooming", "import_timeline", "events", "categories", "contact"],
129
130
131
132
133
134 body=_("""
135 The timeline shows dates according to the Gregorian calendar on the x-axis. Currently the earliest date is limited to Julian day 0 (November 24, 4714 BC).
136
137 Future versions might support various kinds of timelines so that you for example can specify a time in terms of number of minutes since a start time. If you are interested in such a feature, please get in touch.
138
139 The timeline is divided in two areas with a horizontal adjustable divider line. Period events are displayed below the line and point events are displayed above the line.
140 """))
141
142 help_system.install_page(
143 page_id="scrolling",
144 header=_("Scrolling Timeline"),
145 related_pages=["timeline"],
146
147
148
149
150
151 body=_("""
152 A Timeline can be scrolled both horizontal (along time axis) and vertically (along event axis)
153
154 There are two ways to scroll horizontal. You can either use the different options in the Navigation menu or you can use the mouse. To use the mouse, hold down the left mouse button and drag the mouse horizontally.
155
156 To scroll vertically, hold down the Shift- and Ctrl-keys and scroll the mouse wheel.
157 Events are scrolled towards or away from the divider line separating point- and period-events.
158
159 """))
160
161 help_system.install_page(
162 page_id="zooming",
163 header=_("Zooming Timeline"),
164 related_pages=["timeline"],
165
166
167
168
169
170 body=_("""
171 A Timeline can be Zoomed both horizontal (along time axis) and vertically (along event axis)
172
173 To zoom horizontal, hold down the Ctrl-key and scroll the mouse wheel.
174
175 To zoom vertically, hold down the Alt-key and scroll the mouse wheel.
176 """))
177
178 help_system.install_page(
179 page_id="events",
180 header=_("Events"),
181 related_pages=["event_properties", "add_icon", "create_event", "select_events", "edit_event", "delete_event", "move_event_vertically", "duplicate_event", "categories", "search_event"],
182
183
184
185
186
187 body=_("""
188 An event is the basic data type for representing information on the timeline. It must specify where on the timeline it should be placed (when that event happened). This can be either a specific point in time or a period.
189 """))
190
191 help_system.install_page(
192 page_id="era",
193 header=_("Era"),
194 related_pages=["timeline"],
195
196
197
198
199
200 body=_("""
201 An Era is A clearly defined period of time of arbitrary but well-defined length.
202
203 An Era is displayed as a background with the color defined for the Era. The Era name is written att the bottom of the timeline.
204 """))
205
206 help_system.install_page(
207 page_id="event_properties",
208 header=_("Event Properties"),
209 related_pages=["events", "event_containers", "add_icon"],
210
211
212
213
214
215 body=_("""
216 For an event the following properties can be defined.
217
218 - Start Date and Time.
219 - End Date and Time (if period event).
220 - Text - The label displayed for an event.
221 - Category - A way to group events together.
222 - Container - Another way to group events together.
223 - Fuzzy - Draw start and end of event fuzzy, to indicate that exact times are unknown.
224 - Locked - Start- and End-points can't be changed.
225 - Ends Today - The End-point is always set to current date.
226 - Description - Event description that is shown i the balloon.
227 - Icon - Image icon shown in balloon.
228 - Alert - An alert dialog is opened at the specified alert time.
229 - Hyperlinks - A list of hyperlink that can be reached in the event context menu.
230 """))
231
232 help_system.install_page(
233 page_id="milestones",
234 header=_("Milestones"),
235 related_pages=["events"],
236
237
238
239
240
241 body=_("""
242 A milestone is a special case of a point event. It is rendered on the timescale of a timeline and it can have a desciption shown when hooverd over. It can also have a one character label that is displayed in the milestone box.
243
244 A milestone ...
245
246 * is created by selecting the menu alternative Timeline -> Create milestone.
247
248 * is edited by doubleclicking on it.
249
250 * is deleted by clicking on it and thereafter click the delete button.
251
252 * can be dragged to a new position.
253 """))
254
255
256 help_system.install_page(
257 page_id="categories",
258 header=_("Categories"),
259 related_pages=["categories_delete", "events"],
260
261
262
263
264
265 body=_("""
266 Categories are used to group events. An event can only belong to one category. All events that belong to the same category are displayed with the same background color.
267 """))
268
269 help_system.install_page(
270 page_id="experimental_features",
271 header=_("Experimental Features"),
272
273
274
275
276
277 body=_("""
278 Experimental features are features implemented in Timeline but not yet decided to be permanent.
279
280 An experimental feature can be switched on or off in the preferences dialog.
281
282 The functionality in these features may not be fully implemented and may not have been as extensively tested as the rest of the application.
283
284 The users feedback can be important when the decision to make the features permanent or not, is taken.
285 """))
286
287 help_system.install_page(
288 page_id="create_event",
289 header=_("Create event"),
290 related_pages=["events", "delete_event"],
291
292
293
294
295
296 body=_("""
297 The *Create Event* dialog can be opened in the following ways:
298
299 - Select *Timeline* - *Create Event* from the menu.
300 - Double click with the *left* mouse button on the timeline.
301 - Press the *Ctrl* key, thereafter hold *left* mouse button down on the timeline, drag the mouse and release it.
302 """))
303
304 help_system.install_page(
305 page_id="undo_action",
306 header=_("Undo/Redo"),
307 related_pages=["create_event", "edit_event", "delete_event", "edit_categories"],
308
309
310
311
312
313 body=_("""
314 The *Undo* function can revert an action such as creating an event, editing a category or deleting an event.
315
316 To revert an action you:
317
318 - Use the Ctrl+Z key (Key combination can be changed by user)
319 - Select the menu *Timeline* - *Undo*
320
321 To save memory usage we have decided to limit the number of actions that can be reverted.
322 This means that only the 10 latest actions can be Undone.
323
324 An action that is Undone can also be Redone if you:
325
326 - Use the Alt+Z key (Key combination can be changed by user)
327 - Select the menu *Timeline* - *Redo*
328
329 """))
330
331 help_system.install_page(
332 page_id="edit_event",
333 header=_("Edit event"),
334 related_pages=["events", "select_events"],
335
336
337
338
339
340 body=_("""
341 The *Edit Event* dialog can be opened by double clicking on an event or by selecting one event and select the 'Timeline -> Edit Selected Event...' menu.
342
343 An image icon can be associated with an event by dragging the image file and dropping it on an event.
344 """))
345
346 help_system.install_page(
347 page_id="move_event_vertically",
348 header=_("Move event vertically"),
349 related_pages=["events", "select_events"],
350
351
352
353
354
355 body=_("""
356 An event can be moved vertically. This is done by first selecting the event and thereafter using the Up or Down keys.
357 """))
358
359 help_system.install_page(
360 page_id="duplicate_event",
361 header=_("Duplicate event"),
362 related_pages=["events", "select_events"],
363
364
365
366
367
368 body=_("""
369 An event can be duplicated. Select the event you want to duplicate and select the 'Timeline -> Duplicate Selected Event...' menu.
370 Now a dialog appears in which you can define
371
372 - How many duplications to do
373 - The time period used
374 - The frequency of time periods
375 - The direction
376
377 If number of duplications = 3, time span = day and frequency = 2, you will get 3 new copies of the event spread out with the time span of 2 days between them.
378
379 You can also get to the duplication dialog from the event context menu, wich appears if you right-click an event with the mouse.
380 """))
381
382 help_system.install_page(
383 page_id="search_event",
384 header=_("Search event"),
385 related_pages=["events", ],
386
387
388
389
390
391 body=_("""
392 You can search for an event by selecting the Edit -> Search menu.
393
394 A text control is opened in the lower left corner of the application.
395
396 Enter a target text in the text control and click Enter.
397 If the text is found in the Text or Description of any event, the first event
398 found is highlighted for a short period of time.
399
400 By clicking on the icons to the right of the text control you can navigate
401 back and forth between all the events that has been found. You can also
402 select an event from a list of all found events.
403 """))
404
405 help_system.install_page(
406 page_id="select_events",
407 header=_("Selecting events"),
408
409
410
411
412
413 body=_("""
414 To select an event, click on it. To select multiple events, hold down the *Ctrl* key while clicking events.
415 """))
416
417 help_system.install_page(
418 page_id="import_timeline",
419 header=_("Import timeline"),
420 related_pages=["timeline"],
421
422
423
424
425
426 body=_("""
427 This feature can be used to merge two timelines into one.
428
429 First open a timeline and then select menu 'File -> Import timeline...' and select the timeline to be imported.
430 """))
431
432 help_system.install_page(
433 page_id="event_containers",
434 header=_("Event Containers"),
435 related_pages=["events", "experimental_features"],
436
437
438
439
440
441 body=_("""
442 Containers are a way to group events together.
443 In a container events can not overlap, so if you add a new event to a container
444 all other events are moved to give room for the new event. The same thing happens
445 if you resize an event within the container.
446
447 Have a look at this video for a demo.
448 <http://www.youtube.com/watch?v=dBwEQ3vqB_I>
449
450 From version 1.8 there is a second container strategy that let's events overlap in time within the container.
451 This strategy is implemented as an experimental feature and can be selected in the preferences dialog.
452 """))
453
454 help_system.install_page(
455 page_id="delete_event",
456 header=_("Delete event"),
457 related_pages=["events", "select_events"],
458
459
460
461
462
463 body=_("""
464 To delete an event, select it and press the *Del* key. Multiple events can be deleted at the same time.
465 """))
466
467 help_system.install_page(
468 page_id="categories_delete",
469 header=_("Will associated events be deleted when I delete a category?"),
470
471
472
473
474
475 body=_("""
476 No. The events will still be there but they will not belong to a category.
477 """))
478
479 help_system.install_page(
480 page_id="add_icon",
481 header=_("Add a user defined icon"),
482 related_pages=["event_properties"],
483
484
485
486
487
488 body=_("""
489 Icons used for the event properties
490
491 - Fuzzy
492 - Locked
493 - Hyperlink
494
495 can be user defined.
496
497 To use an icon of your own you create a png image file and place it in
498 the subdirectory icons/event_icons.
499 Now the icon can be selected in the properties dialog on the Icons tab.
500 """))
501
502 help_system.install_page(
503 page_id="edit_categories",
504 header=_("Edit categories"),
505 related_pages=["categories"],
506
507
508
509
510
511 body=_("""
512 Categories can be managed in the *Edit Categories* dialog (*Timeline* > *Edit Categories*). To edit an existing category, double click on it.
513
514 The visibility of categories can also be edited in the sidebar (*View* > *Sidebar*).
515 """))
516
517 help_system.install_page(
518 page_id="contact",
519 header=_("Contact"),
520
521
522
523
524
525 body=_("""
526 If you have more questions about Timeline, or if you want to get in contact with users and developers of Timeline, send an email to the user mailing list: <thetimelineproj-user@lists.sourceforge.net>. (Please use English.)
527 """))
528
529 help_system.install_page(
530 page_id="why_not_timeline_in_my_language",
531 header=_("Why is Timeline not available in my language?"),
532 related_pages=["contact"],
533
534
535
536
537
538 body=_("""
539 Timeline is developed and translated by volunteers. If you would like to contribute translations you are very much welcome to contact us.
540 """))
541