Package Gnumed :: Package timelinelib :: Package help :: Module pages
[frames] | no frames]

Source Code for Module Gnumed.timelinelib.help.pages

  1  # Copyright (C) 2009, 2010, 2011  Rickard Lindberg, Roger Lindberg 
  2  # 
  3  # This file is part of Timeline. 
  4  # 
  5  # Timeline is free software: you can redistribute it and/or modify 
  6  # it under the terms of the GNU General Public License as published by 
  7  # the Free Software Foundation, either version 3 of the License, or 
  8  # (at your option) any later version. 
  9  # 
 10  # Timeline is distributed in the hope that it will be useful, 
 11  # but WITHOUT ANY WARRANTY; without even the implied warranty of 
 12  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
 13  # GNU General Public License for more details. 
 14  # 
 15  # You should have received a copy of the GNU General Public License 
 16  # along with Timeline.  If not, see <http://www.gnu.org/licenses/>. 
 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   
32 -def install(help_system):
33 34 help_system.install_page( 35 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 - **%s** 44 - Help(timeline) 45 - Help(events) 46 - Help(categories) 47 - **%s** 48 - Help(create_event) 49 - Help(edit_event) 50 - Help(move_event_vertically) 51 - Help(delete_event) 52 - Help(edit_categories) 53 - Help(select_events) 54 - **Help(contact)** 55 """ % (_("Questions and answers"), _("Concepts"), _("Tasks")))) 56 57 58 help_system.install_page( 59 id="where_is_save", 60 header=_("Where is the save button?"), 61 # TRANSLATORS: This text uses special markup. 62 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 63 # Just write them as they are. 64 # Stars produce emphasized text. DON'T remove them. 65 # Dashes produce bullet lists. DON'T remove them. 66 body=_(""" 67 There is no save button. Timeline will automatically save your data whenever needed. 68 """)) 69 70 71 help_system.install_page( 72 id="week_numbers_sunday_week_start", 73 header=_("Where do the week numbers go if I start my weeks on Sunday?"), 74 # TRANSLATORS: This text uses special markup. 75 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 76 # Just write them as they are. 77 # Stars produce emphasized text. DON'T remove them. 78 # Dashes produce bullet lists. DON'T remove them. 79 body=_(""" 80 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. 81 """)) 82 83 84 help_system.install_page( 85 id="timeline", 86 header=_("Timeline"), 87 related_pages=["events", "categories", "contact"], 88 # TRANSLATORS: This text uses special markup. 89 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 90 # Just write them as they are. 91 # Stars produce emphasized text. DON'T remove them. 92 # Dashes produce bullet lists. DON'T remove them. 93 body=_(""" 94 The timeline shows dates according to the Gregorian calendar on the x-axis. Currently the dates are limited to dates between year 10 and year 9989. 95 96 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. 97 """)) 98 99 help_system.install_page( 100 id="events", 101 header=_("Events"), 102 related_pages=["categories"], 103 # TRANSLATORS: This text uses special markup. 104 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 105 # Just write them as they are. 106 # Stars produce emphasized text. DON'T remove them. 107 # Dashes produce bullet lists. DON'T remove them. 108 body=_(""" 109 An event is the basic data type for representing information on the timeline. It must specify where on the timeline is should be placed (when that event happened). This can be either a specific point in time or a period. 110 """)) 111 112 help_system.install_page( 113 id="categories", 114 header=_("Categories"), 115 related_pages=["categories_delete", "events"], 116 # TRANSLATORS: This text uses special markup. 117 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 118 # Just write them as they are. 119 # Stars produce emphasized text. DON'T remove them. 120 # Dashes produce bullet lists. DON'T remove them. 121 body=_(""" 122 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. 123 """)) 124 125 help_system.install_page( 126 id="create_event", 127 header=_("Create event"), 128 related_pages=["events", "delete_event"], 129 # TRANSLATORS: This text uses special markup. 130 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 131 # Just write them as they are. 132 # Stars produce emphasized text. DON'T remove them. 133 # Dashes produce bullet lists. DON'T remove them. 134 body=_(""" 135 The *Create Event* dialog can be opened in the following ways: 136 137 - Select *Timeline* - *Create Event* from the menu. 138 - Double click with the *left* mouse button on the timeline. 139 - Press the *Ctrl* key, thereafter hold *left* mouse button down on the timeline, drag the mouse and release it. 140 """)) 141 142 help_system.install_page( 143 id="edit_event", 144 header=_("Edit event"), 145 related_pages=["events", "delete_event"], 146 # TRANSLATORS: This text uses special markup. 147 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 148 # Just write them as they are. 149 # Stars produce emphasized text. DON'T remove them. 150 # Dashes produce bullet lists. DON'T remove them. 151 body=_(""" 152 The *Edit Event* dialog can be opened by double clicking on an event. 153 """)) 154 155 help_system.install_page( 156 id="move_event_vertically", 157 header=_("Move event vertically"), 158 related_pages=["events", "select_events"], 159 # TRANSLATORS: This text uses special markup. 160 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 161 # Just write them as they are. 162 # Stars produce emphasized text. DON'T remove them. 163 # Dashes produce bullet lists. DON'T remove them. 164 body=_(""" 165 An event can be moved vertically. This is done by first selecting the event and therefter using the Alt+Up or Alt+Down keys. 166 """)) 167 168 help_system.install_page( 169 id="select_events", 170 header=_("Selecting events"), 171 # TRANSLATORS: This text uses special markup. 172 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 173 # Just write them as they are. 174 # Stars produce emphasized text. DON'T remove them. 175 # Dashes produce bullet lists. DON'T remove them. 176 body=_(""" 177 To select an event, click on it. To select multiple events, hold down the *Ctrl* key while clicking events. 178 """)) 179 180 help_system.install_page( 181 id="delete_event", 182 header=_("Delete event"), 183 related_pages=["select_events", "events"], 184 # TRANSLATORS: This text uses special markup. 185 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 186 # Just write them as they are. 187 # Stars produce emphasized text. DON'T remove them. 188 # Dashes produce bullet lists. DON'T remove them. 189 body=_(""" 190 To delete an event, select it and press the *Del* key. Multiple events can be deleted at the same time. 191 """)) 192 193 help_system.install_page( 194 id="categories_delete", 195 header=_("Will associated events be deleted when I delete a category?"), 196 # TRANSLATORS: This text uses special markup. 197 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 198 # Just write them as they are. 199 # Stars produce emphasized text. DON'T remove them. 200 # Dashes produce bullet lists. DON'T remove them. 201 body=_(""" 202 No. The events will still be there but they will not belong to a category. 203 """)) 204 205 help_system.install_page( 206 id="edit_categories", 207 header=_("Edit categories"), 208 related_pages=["categories"], 209 # TRANSLATORS: This text uses special markup. 210 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 211 # Just write them as they are. 212 # Stars produce emphasized text. DON'T remove them. 213 # Dashes produce bullet lists. DON'T remove them. 214 body=_(""" 215 Categories can be managed in the *Edit Categories* dialog (*Timeline* > *Edit Categories*). To edit an existing category, double click on it. 216 217 The visibility of categories can also be edited in the sidebar (*View* > *Sidebar*). 218 """)) 219 220 help_system.install_page( 221 id="contact", 222 header=_("Contact"), 223 # TRANSLATORS: This text uses special markup. 224 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 225 # Just write them as they are. 226 # Stars produce emphasized text. DON'T remove them. 227 # Dashes produce bullet lists. DON'T remove them. 228 body=_(""" 229 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.) 230 """)) 231 232 help_system.install_page( 233 id="why_not_timeline_in_my_language", 234 header=_("Why is Timeline not available in my language?"), 235 related_pages=["contact"], 236 # TRANSLATORS: This text uses special markup. 237 # DON'T translate 'HelpFigure(..)' or 'Help(..)'. 238 # Just write them as they are. 239 # Stars produce emphasized text. DON'T remove them. 240 # Dashes produce bullet lists. DON'T remove them. 241 body=_(""" 242 Timeline is developed and translated by volunteers. If you would like to contribute translations you are very much welcome to contact us. 243 """))
244