def save_tagtree(self):
""" Saves the tag tree to an XML file """
if not self.tagfile_loaded:
return
doc, xmlroot = cleanxml.emptydoc(TAG_XMLROOT)
tags = self._tagstore.get_main_view().get_all_nodes()
already_saved = []
for tagname in tags:
if tagname in already_saved:
continue
tag = self._tagstore.get_node(tagname)
attributes = tag.get_all_attributes(butname=True, withparent=True)
if "special" in attributes or len(attributes) == 0:
continue
t_xml = doc.createElement("tag")
t_xml.setAttribute("name", tagname)
for attr in attributes:
# skip labels for search tags
if tag.is_search_tag() and attr == "label":
continue
value = tag.get_attribute(attr)
if value:
t_xml.setAttribute(attr, value)
xmlroot.appendChild(t_xml)
already_saved.append(tagname)
cleanxml.savexml(TAGS_XMLFILE, doc, backup=True)
def save_tagtree(self):
""" Saves the tag tree to an XML file """
if not self.tagfile_loaded:
return
doc, xmlroot = cleanxml.emptydoc(TAG_XMLROOT)
tags = self._tagstore.get_main_view().get_all_nodes()
already_saved = []
for tagname in tags:
if tagname in already_saved:
continue
tag = self._tagstore.get_node(tagname)
attributes = tag.get_all_attributes(butname=True, withparent=True)
if "special" in attributes or len(attributes) == 0:
continue
t_xml = doc.createElement("tag")
t_xml.setAttribute("name", tagname)
for attr in attributes:
# skip labels for search tags
if tag.is_search_tag() and attr == 'label':
continue
value = tag.get_attribute(attr)
if value:
t_xml.setAttribute(attr, value)
xmlroot.appendChild(t_xml)
already_saved.append(tagname)
cleanxml.savexml(TAGS_XMLFILE, doc, backup=True)
def save(self, quit=False):
"""
Saves the backends parameters.
@param quit: If quit is true, backends are shut down
"""
try:
self.start_get_tasks_thread.join()
except Exception:
pass
doc, xmlconfig = cleanxml.emptydoc("config")
# we ask all the backends to quit first.
if quit:
# we quit backends in parallel
threads_dic = {}
for b in self.get_all_backends():
thread = threading.Thread(target=b.quit)
threads_dic[b.get_id()] = thread
thread.start()
for backend_id, thread in threads_dic.iteritems():
# after 20 seconds, we give up
thread.join(20)
if thread.isAlive():
Log.error("The %s backend stalled while quitting",
backend_id)
# we save the parameters
for b in self.get_all_backends(disabled=True):
t_xml = doc.createElement("backend")
for key, value in b.get_parameters().iteritems():
if key in ["backend", "xmlobject"]:
# We don't want parameters, backend, xmlobject:
# we'll create them at next startup
continue
param_type = b.get_parameter_type(key)
value = b.cast_param_type_to_string(param_type, value)
t_xml.setAttribute(str(key), value)
# Saving all the projects at close
xmlconfig.appendChild(t_xml)
datadir = CoreConfig().get_data_dir()
datafile = os.path.join(datadir, CoreConfig.DATA_FILE)
cleanxml.savexml(datafile, doc, backup=True)
# Saving the tagstore
self.save_tagtree()
def save(self, quit=False):
"""
Saves the backends parameters.
@param quit: If quit is true, backends are shut down
"""
try:
self.start_get_tasks_thread.join()
except Exception:
pass
doc, xmlconfig = cleanxml.emptydoc("config")
# we ask all the backends to quit first.
if quit:
# we quit backends in parallel
threads_dic = {}
for b in self.get_all_backends():
thread = threading.Thread(target=b.quit)
threads_dic[b.get_id()] = thread
thread.start()
for backend_id, thread in threads_dic.iteritems():
# after 20 seconds, we give up
thread.join(20)
if thread.isAlive():
Log.error("The %s backend stalled while quitting",
backend_id)
# we save the parameters
for b in self.get_all_backends(disabled=True):
t_xml = doc.createElement("backend")
for key, value in b.get_parameters().iteritems():
if key in ["backend", "xmlobject"]:
# We don't want parameters, backend, xmlobject:
# we'll create them at next startup
continue
param_type = b.get_parameter_type(key)
value = b.cast_param_type_to_string(param_type, value)
t_xml.setAttribute(str(key), value)
# Saving all the projects at close
xmlconfig.appendChild(t_xml)
datadir = CoreConfig().get_data_dir()
datafile = os.path.join(datadir, CoreConfig.DATA_FILE)
cleanxml.savexml(datafile, doc, backup=True)
# Saving the tagstore
self.save_tagtree()
def save_tagtree(self):
if self.tagfile:
doc, xmlroot = cleanxml.emptydoc(TAG_XMLROOT)
tags = self.__tagstore.get_main_view().get_all_nodes()
already_saved = [] #We avoid saving the same tag twice
#we don't save tags with no attributes
#It saves space and allow the saved list growth to be controlled
for tname in tags:
t = self.__tagstore.get_node(tname)
attr = t.get_all_attributes(butname = True, withparent = True)
if "special" not in attr and len(attr) > 0:
tagname = t.get_name()
if not tagname in already_saved:
t_xml = doc.createElement("tag")
t_xml.setAttribute("name", tagname)
already_saved.append(tagname)
for a in attr:
value = t.get_attribute(a)
if value:
t_xml.setAttribute(a, value)
xmlroot.appendChild(t_xml)
cleanxml.savexml(self.tagfile, doc)
def populate():
"""On the first run of GTG, populate the task list with tasks meant to
act as a GTG tutorial."""
doc, root = cleanxml.emptydoc("project")
# Task 0@1: Getting started with GTG
title1 = _("Getting Started With GTG")
text1 = _(
"Welcome to Getting Things GNOME!, your new task manager! In Getting "
"Things GNOME! (GTG), everything is a task. From building a bridge"
" over the Pacific Ocean to changing a light bulb or organizing a"
" party!\n\n"
"If you are new to GTG, please take the time to read this, as it will"
" provide you useful information about how to use GTG to organize"
" your everyday life.\n"
"\n"
"Creating and editing tasks:\n"
"\n"
"Using GTG is easy: you organize what you have to do by creating new"
" tasks. To do this, simply press the "New Task" button, "
"edit the task by describing it, set some parameters, and that's "
"it! Once a task done, you can close it by pressing the "Mark As"
" Done" button.\n"
"\n"
"In GTG, a task is automatically saved while you are editing it. No"
" need to press any "Save" button! Try it: add some text to"
" this task, close the window, and reopen it: your changes are still"
" there!\n\n"
"About subtasks:\n"
"\n"
"In life, you often get more things done by refining them in "
"smaller, more operational tasks. GTG helps to do just this by "
"defining "subtasks". In GTG, those subtasks are "
"considered as prerequisites that must be completed before being able"
" to close their parent task.\n\n"
"Therefore, in GTG, a task might host one or several subtasks. Those "
"appear as links in the task description, just like the link below. "
"To open and edit a subtask, simply click on its link! Try it"
" yourself: open the following subtask:\n"
"<subtask>1@1</subtask>\n"
"\n"
"Closing a task:\n"
"\n"
"In GTG, once you are done with a task, you can close it by pushing "
"either the "Mark as Done" or the "Dismiss" "
"button. Use the first one if the task is done, and the latter if you"
" want to close it because it is not relevant anymore. Want to try it"
"? Try to close the subtask above for instance!\n"
"\n"
"When you close a task, you will notice that all its subtasks will be"
" automatically closed too! Indeed, GTG considers that if you have"
" completed a given task, then you don't need to do its subtasks"
" anymore (they were prerequisites, after all).\n"
"\n"
"Note that the tasks that you have marked as done or dismissed are "
"listed in the "Closed Tasks Pane" which is hidden by"
" default, but you can easily show it using the View menu.\n"
"\n"""
"Learn more about GTG:\n"
"\n"
"If you are interested in knowing more about "
"GTG's other features, you will find more information here:\n"
"<subtask>2@1</subtask>\n"
"<subtask>3@1</subtask>\n"
"<subtask>4@1</subtask>\n"
"<subtask>5@1</subtask>\n"
"<subtask>6@1</subtask>\n"
"<subtask>7@1</subtask>\n"
"<subtask>8@1</subtask>\n"
"\n"
"You can also browse GTG documentation by pressing F1 or opening it"
" using the Help menu.\n"
"\n"
"We sincerely hope you will enjoy using GTG, and thank you for trying"
" it out! Please send us bug reports and ideas for improvement using"
" this web page: https://bugs.launchpad.net/gtg/+filebug If you want "
"to get tips for using GTG or be informed about the newest features, "
"also visit our blog at http://gtg.fritalk.com\n"
"\n"
"The GTG team.")
task1 = addtask(doc, "0@1", title1, text1,
["1@1", "2@1", "3@1", "4@1", "5@1", "6@1", "7@1", "8@1"])
root.appendChild(task1)
# Task 1@1: Learn to use subtasks
title2 = _("Learn How To Use Subtasks")
text2 = _(
"A "Subtask" is something that you need to do first before "
"being able to accomplish your task. In GTG, the purpose of subtasks "
"is to cut down a task in smaller subtasks that are easier to achieve"
" and to track down.\n\n"
"To insert a subtask in the task description (this window, for "
"instance), begin a line with "-", then write the subtask "
"title and press Enter.\n"
"\n"
"Try inserting one subtask below. Type "- This is my first "
"subtask!", for instance, and press Enter:\n"
"\n"
"\n"
"\n"
"Alternatively, you can also use the "Insert Subtask" "
"button.\n\n"
"Note that subtasks obey to some rules: first, a subtask's due date "
"can never happen after its parent's due date and, second, when you "
"mark a parent task as done, its subtasks will also be marked as "
"done.\n\n"
"And if you are not happy with your current tasks/subtasks "
"organization, you can always change it by drag-and-dropping tasks on"
" each other in the tasks list.")
task2 = addtask(doc, "1@1", title2, text2, [])
root.appendChild(task2)
# Task 2@1: Learn to use tags
title3 = _("Learn How To Use Tags")
text3 = _(
"In GTG, you use tags to sort your tasks. A tag is a simple word that"
" begins with "@".\n"
"\n"
"Try to type a word beginning with "@" here:\n"
"\n"
"Once it becomes yellow, it is a tag! And this tag is now linked to "
"the task!\n"
"\n"
"Using the View menu, you can enable a sidebar which displays all the"
" tags you are using. This allows you to easily see all tasks "
"associated to a given tag.\n"
"\n"
"If you right-click on a tag in the sidebar, you can also edit it. It"
" allows you to assign it a color or an icon for instance. This is "
"handy if you want to quickly identify the tasks associated to a "
"given tag in the task list!\n\n"
"New tags are always added exclusively to the currently edited task, "
"and never to its subtasks. However, when you create a new subtask, "
"it will inherit its parent's tags.\n"
"\n"
"If you need a more advanced task organization, you can also create a"
" hierarchy of tags by drag-and-dropping a tag onto another. This "
"is useful when you want to regroup several tags together and see all"
" related tasks easily. For instance, if you have two tags @money and"
" @to_pay, and you drag @to_pay on @money, every task tagged with "
"@to_pay will also appear when you select @money.")
task3 = addtask(doc, "2@1", title3, text3, [])
root.appendChild(task3)
# Task 3@1: Using the Workview
title4 = _("Learn How To Use The Work View")
text4 = _(
"If you press the "Work View" button, only actionable tasks"
" will be displayed in your list.\n"
"\n"
"What is an actionable task? It's a task you can do directly, right "
"now.\n\n"
"It's a task that is already "start-able", i.e. the start "
"date is already over.\n"
"\n"
"It's a task that doesn't have open subtasks, i.e. you can do the "
"task itself directly.\n"
"\n"
"It's a task that has a due date different than "Someday", "
"since this kind of date is reserved for things that needs more "
"thoughts before being actionable.\n"
"\n"
"Thus, in short, the Work View shows you tasks that you can do right "
"now. It's very useful when you want to get things done and to focus "
"on the relevant tasks!\n"
"\n"
"If you use tags, you can right click on a tag in the sidebar and "
"choose to hide tasks assigned to this particular tag in the Work "
"View. It is very useful if you have a tag like "@wait" "
"that you use for tasks blocked by some external event (i.e. a phone "
"call you wait to receive).\n\n"
"And finally, an important note regarding the Work View: since the "
"Work View is updated instantaneously, if you edit your task while "
"using the Work View, this task might disappear due to the change you"
" just made (e.g. adding a subtask, adding a tag hidden in the Work "
"View, etc.). To avoid this, it's better not to edit your task while "
"using the Work View. ")
task4 = addtask(doc, "3@1", title4, text4, [])
root.appendChild(task4)
# Task 5@1: Plugins
title5 = _("Learn How To Use Plugins")
text5 = _(
"GTG has the ability to add plugins to extend its core functionality."
"\n\n"
"Some examples of the currently available plugins are the "
"notification icon which displays a handy shortcut to GTG in your "
"notification space, or the closed tasks remover which automatically "
"deletes old tasks from your closed tasks list.\n"
"\n"
"You can find the Plugin Manager by selecting Edit in the Menu Bar, "
"then clicking Plugins.")
task5 = addtask(doc, "4@1", title5, text5, [])
root.appendChild(task5)
# Task 5@1: Reporting bugs
title6 = _("Reporting Bugs")
text6 = _(
"GTG is still beta software. We like it and use it everyday but you "
"will probably encounter some bugs will you do.\n"
"\n"
"Please, help us improving GTG by reporting them on our Launchpad "
"page:https://bugs.launchpad.net/gtg/+filebug\n"
"\n"
"We need you to make this software better. Any contribution, any "
"idea is welcome!\n"
"\n"
"If you have some trouble with GTG, we might be able to help you or "
"to solve your problem really quickly.")
task6 = addtask(doc, "5@1", title6, text6, [])
root.appendChild(task6)
# Task 6@1: Learn how to use the QuickAdd Entry
title7 = _("Learn How To Use The Quick Add Entry")
text7 = _(
"The Quick Add Entry is the fastest way to create a new task. Use "
"the check box in the View menu to enable and disable the entry field"
".\n\n"
"To add a task simply type its title in the entry and press Enter. "
"The task will be created and selected in the task browser. If a tag "
"is selected in the Tags Sidebar, it will be applied to the task you "
"created.\n\n"
"You can also create a task in the Quick Add Entry and at the same "
"time specify its tags, due and defer date. Follow these format rules"
":\n\n"
"tags:tag1,tag2,tag3\n"
"\n"
"Using this you can apply as many tags as you wish using comma as "
"separator. Note that any word in the title that begins with ""
"@" will also be interpreted as a tag!\n"
"\n"
"due:date\n"
"defer:date\n"
"\n"
"Using this you can apply a due date or a defer date. Dates can be "
"formated as per your locale or yyyy-mm-dd (for example 2012-04-01) "
"or yyyymmdd (20120401) "
"or mmdd (0401 - the year being implicitly the current one) or today,"
" tomorrow or a weekday name (due:monday means due next Monday). "
"Dates which are added in this way will not appear in the task title."
"\n\n"
"Examples:\n"
"\n"
"buy stationary tags:purchases,office due:20120330 defer:tuesday\n"
"\n"
"The above example tells GTG to create a new task with the title "
""buy stationary", under the tags "purchases" "
"and "office", with the due date March 30, 2012 and the "
"start date next Tuesday.\n"
"\n"
"call mum tags:family,calls due:sunday defer:tomorrow\n"
"\n"
"The above example tells GTG to create a new task with the title "
""call mum", under the tags "family" and "
""calls", with the due date next Sunday and the start "
"date tomorrow.")
task7 = addtask(doc, "6@1", title7, text7, [])
root.appendChild(task7)
# Task 7@1: Learn How To Use Synchonization Services
title8 = _("Learn How To Use Synchronization Services")
text8 = _(
"Synchronization Services allow GTG to synchronize (meaning to have "
"access or to import) tasks, notes or bugs from other sites or "
"services like Launchpad, Remember the Milk, Tomboy, etc.\n"
"\n"
"This can incredibly useful if, for instance, you want to access your"
" tasks on several instances of GTG running on separate computers, or"
" if you want to edit your tasks using an online service. GTG can "
"also import tasks from specific sites like launchpad for instance, "
"which allows you to manage the bug reports you're working on in GTG!"
"\n\n"
"To use Synchronization Services, use the Edit menu, and select "
""Synchronization Services". You will then have the "
"possibility to select among several online or local services "
"from/to where you can import or export your tasks.\n"
"\n"
"If you want to know more about Synchronization Services, you can "
"read more about them by in the dedicated documentation in GTG's help"
" (use the Help menu or press F1 to get access to it).")
task8 = addtask(doc, "7@1", title8, text8, [])
root.appendChild(task8)
# Task 8@1: Learn How To Search For Tasks
title9 = _("Learn How To Search For Tasks")
text9 = _(
"To help you to find specific tasks more easily, GTG allows you to "
"search for tasks based on their content.\n"
"\n"
"Searching for tasks is really easy: just type the words you are "
"looking for in the Quick Add Entry, and select "Search" in"
" the menu that will appear automatically.\n"
"\n"
"GTG stores your searches in the sidebar, under the "Search"
"" section. You can thus always go back to a previous search "
"need it. Search results are updated automatically, so you always get"
" all the tasks matching your search request.\n"
"\n"
"GTG also saves all the search requests you have made until you "
"explicitely delete them (which you can do by right-clicking on them "
"and selecting "Delete"). That allows you to safely quit "
"GTG without loosing your search requests. This can be very useful "
"when you use the search features to identify specific tasks "
"regularly!\n\n"
"GTG search feature is really powerful and accept many parameters "
"that allows you to search for very specific tasks. For instance, "
"using the search query "@errands !today", you can search "
"for tasks with the @errands tag that must be done today. To learn "
"more about those search query parameters, you can read the "
"documentation available in GTG's help (press F1 or use the Help menu"
" to get access to it).")
task9 = addtask(doc, "8@1", title9, text9, [])
root.appendChild(task9)
return doc
def populate():
doc,root = cleanxml.emptydoc("project")
#Task 0@1: Getting started with GTG
title1 = _("Getting started with GTG")
text1 = _("""Welcome to Getting Things Gnome!, your new task manager.
In GTG, everything is a task. From building a bridge over the Pacific Ocean to changing a light bulb or organizing a party. When you edit a task, it is automatically saved.
Once a task is done, you can push the "Mark as done" button. If the task is not relevant any-more, simply press "Dismiss".
A task might be composed of multiple subtasks that appear as links in the description. Simply click on the following link:""")
text1 += "\n<subtask>1@1</subtask>\n"
text1 += _("""Once you've read the above subtask, mark it as Done. If you don't want to do the task, mark it as dismissed. Done and Dismissed tasks are kept in the closed tasks pane, hidden by default but you can easily enable it in the View menu.
If you choose to close this current task, subtasks will be automatically closed too. We indeed consider that, if you achieve a given task, you don't need to do the subtask anymore.
Other stuff you should read:""")
text1 += """\n<subtask>2@1</subtask>
<subtask>3@1</subtask>
<subtask>4@1</subtask>
<subtask>5@1</subtask>
<subtask>6@1</subtask>\n"""
text1 += _("""We hope that you will appreciate GTG. Please send us bug reports and ideas for improvement using:
https://bugs.launchpad.net/gtg
Thank you for trying out GTG :-)""")
t1 = addtask(doc, "0@1", title1, text1, [], ["1@1", "2@1", "3@1", "4@1", "5@1", "6@1"])
root.appendChild(t1)
#Task 1@1: Learn to use subtasks
title2 = _("Learn how to use subtasks")
text2 = _("""In the task description (this window), if you begin a line with "-", it will be considered as a "subtask", something that needs to be done in order to accomplish your task. Just try to write "- test subtask" on the next line and press enter.
You can also use the "insert subtask" button.
Tasks and subtasks can be re-organized by drag-n-drop in the tasks list.
Some concepts come with subtasks: for example, a subtask's due date can never be after its parent's due date.
Also, marking a parent as done will mark all the subtasks as done.""")
t2 = addtask(doc, "1@1", title2, text2, [], [])
root.appendChild(t2)
#Task 2@1: Learn to use tags
title3 = _("Learn how to use tags")
text3 = _("""A tag is a simple word that begins with "@".
Try to type a word beginning with @ here:
It becomes yellow, it's a tag.
Tags are useful to sort your tasks. In the view menu, you can enable a sidebar which displays all the tags you are using so you can easily see tasks assigned to a given tag. There's no limit to the number of tags a task can have.
You can drag-n-drop a tag onto another to create \"subtags\". As an example, if you drag the tag @to_pay onto the tag @money, every task tagged with @to_pay will also appear in the view of @money (but the @money tag is not added to the task).
If you right click on a tag in the sidebar you can also set its color. It will allow you to have a more colorful list of tasks, if you want it that way.
A new tag is only added to the current task. There's no recursion and the tag is not applied to subtasks. But when you create a new subtask, this subtask will inherit the tags of its parent as a good primary default (it will also be the case if you add a tag to a parent just after creating a subtask). Of course, you can modify at any time the tags of this particular subtask. It will never be changed by the parent.""")
t3 = addtask(doc, "2@1", title3, text3, ["to_pay", "money"], [])
root.appendChild(t3)
#Task 3@1: Using the Workview
title4 = _("Learn how to use the Workview")
text4 = _("""If you press the "Workview" button, only actionable tasks will be displayed.
What is an actionable task? It's a task you can do directly, right now.
It's a task that is already "start-able", i.e. the start date is already over.
It's a task that doesn't have open subtasks, i.e. you can do the task itself directly.
Thus, the workview will only show you tasks you should do right now.
If you use tags, you can right click on a tag in the sidebar and choose to hide tasks assigned to this particular tag in the workview. It's very useful if you have a tag like "someday" that you use for tasks you would like to do but are not particularly urgent.""")
t4 = addtask(doc, "3@1", title4, text4, [], [])
root.appendChild(t4)
#Task 5@1: Plugins
title5 = _("Learn how to use Plugins")
text5 = _("""GTG has the ability to add plugins to extend it's core functionality.
Some examples of the current plugins are Syncing with Remember the Milk and Evolution, Tomboy/Gnote integration and Geolocalized Tasks.
You can find the Plugin Manager by selecting Edit in the Menu Bar, then clicking Preferences. You will then see a tab labeled Plugins.""")
t5 = addtask(doc, "4@1", title5, text5, [], [])
root.appendChild(t5)
#Task 5@1: Reporting bugs
title6 = _("Reporting bugs")
text6 = _("""GTG is still very alpha software. We like it and use it everyday but you will encounter some bugs.
Please, report them on our Launchpad page:
https://bugs.launchpad.net/gtg
We need you to make this software better. Any contribution, any idea is welcome.
If you have some trouble with GTG, we might be able to help you or to solve your problem really quickly.""")
t6 = addtask(doc, "5@1", title6, text6, [], [])
root.appendChild(t6)
#Task 6@1: Learn how to use the QuickAdd Entry
title7 = _("Learn how to use the QuickAdd Entry")
text7 = _("""The quickadd entry is the quickest way to create a new task. You can show or hide it in the View menu.
For adding a task you just have to type its title in the entry and press return. The task will be created and selected in the task browser. If a tag is selected in the tag panel, this tag is applied to the task you create.
You can also create a task with the attributes "tags", "due", and "defer" in the quickadd entry. The syntax for these attributes is:
tags:tag1,tag2,tag3
- This way you can apply as many tags as you wish using comma as separator
due:date
defer:date
- This way you can apply a due date or a defer date. date can be yyyy-mm-dd (for example 2009-04-01) or yyyymmdd (20090401) or mmdd (0401, in this case the year is implicitly the current one) or today or tomorrow or a weekday name (due:monday means due next Monday)
Attributes which are added in this way apply but do not appear in the title.
If a word begins with @, it is interpreted as a tag.""")
t7 = addtask(doc, "6@1", title7, text7, [], [])
root.appendChild(t7)
return doc
def populate():
"""On the first run of GTG, populate the task list with tasks meant to
act as a GTG tutorial."""
doc, root = cleanxml.emptydoc("project")
# Task 0@1: Getting started with GTG
title1 = _("Getting Started With GTG")
text1 = _(
"Welcome to Getting Things GNOME!, your new task manager! In Getting "
"Things GNOME! (GTG), everything is a task. From building a bridge"
" over the Pacific Ocean to changing a light bulb or organizing a"
" party!\n\n"
"If you are new to GTG, please take the time to read this, as it will"
" provide you useful information about how to use GTG to organize"
" your everyday life.\n"
"\n"
"Creating and editing tasks:\n"
"\n"
"Using GTG is easy: you organize what you have to do by creating new"
" tasks. To do this, simply press the "New Task" button, "
"edit the task by describing it, set some parameters, and that's "
"it! Once a task done, you can close it by pressing the "Mark As"
" Done" button.\n"
"\n"
"In GTG, a task is automatically saved while you are editing it. No"
" need to press any "Save" button! Try it: add some text to"
" this task, close the window, and reopen it: your changes are still"
" there!\n\n"
"About subtasks:\n"
"\n"
"In life, you often get more things done by refining them in "
"smaller, more operational tasks. GTG helps to do just this by "
"defining "subtasks". In GTG, those subtasks are "
"considered as prerequisites that must be completed before being able"
" to close their parent task.\n\n"
"Therefore, in GTG, a task might host one or several subtasks. Those "
"appear as links in the task description, just like the link below. "
"To open and edit a subtask, simply click on its link! Try it"
" yourself: open the following subtask:\n"
"<subtask>1@1</subtask>\n"
"\n"
"Closing a task:\n"
"\n"
"In GTG, once you are done with a task, you can close it by pushing "
"either the "Mark as Done" or the "Dismiss" "
"button. Use the first one if the task is done, and the latter if you"
" want to close it because it is not relevant anymore. Want to try it"
"? Try to close the subtask above for instance!\n"
"\n"
"When you close a task, you will notice that all its subtasks will be"
" automatically closed too! Indeed, GTG considers that if you have"
" completed a given task, then you don't need to do its subtasks"
" anymore (they were prerequisites, after all).\n"
"\n"
"Note that the tasks that you have marked as done or dismissed are "
"listed in the "Closed Tasks Pane" which is hidden by"
" default, but you can easily show it using the View menu.\n"
"\n"
""
"Learn more about GTG:\n"
"\n"
"If you are interested in knowing more about "
"GTG's other features, you will find more information here:\n"
"<subtask>2@1</subtask>\n"
"<subtask>3@1</subtask>\n"
"<subtask>4@1</subtask>\n"
"<subtask>5@1</subtask>\n"
"<subtask>6@1</subtask>\n"
"<subtask>7@1</subtask>\n"
"<subtask>8@1</subtask>\n"
"\n"
"You can also browse GTG documentation by pressing F1 or opening it"
" using the Help menu.\n"
"\n"
"We sincerely hope you will enjoy using GTG, and thank you for trying"
" it out! Please send us bug reports and ideas for improvement using"
" this web page: https://bugs.launchpad.net/gtg/+filebug If you want "
"to get tips for using GTG or be informed about the newest features, "
"also visit our blog at http://gtg.fritalk.com\n"
"\n"
"The GTG team.")
task1 = addtask(doc, "0@1", title1, text1,
["1@1", "2@1", "3@1", "4@1", "5@1", "6@1", "7@1", "8@1"])
root.appendChild(task1)
# Task 1@1: Learn to use subtasks
title2 = _("Learn How To Use Subtasks")
text2 = _(
"A "Subtask" is something that you need to do first before "
"being able to accomplish your task. In GTG, the purpose of subtasks "
"is to cut down a task in smaller subtasks that are easier to achieve"
" and to track down.\n\n"
"To insert a subtask in the task description (this window, for "
"instance), begin a line with "-", then write the subtask "
"title and press Enter.\n"
"\n"
"Try inserting one subtask below. Type "- This is my first "
"subtask!", for instance, and press Enter:\n"
"\n"
"\n"
"\n"
"Alternatively, you can also use the "Insert Subtask" "
"button.\n\n"
"Note that subtasks obey to some rules: first, a subtask's due date "
"can never happen after its parent's due date and, second, when you "
"mark a parent task as done, its subtasks will also be marked as "
"done.\n\n"
"And if you are not happy with your current tasks/subtasks "
"organization, you can always change it by drag-and-dropping tasks on"
" each other in the tasks list.")
task2 = addtask(doc, "1@1", title2, text2, [])
root.appendChild(task2)
# Task 2@1: Learn to use tags
title3 = _("Learn How To Use Tags")
text3 = _(
"In GTG, you use tags to sort your tasks. A tag is a simple word that"
" begins with "@".\n"
"\n"
"Try to type a word beginning with "@" here:\n"
"\n"
"Once it becomes yellow, it is a tag! And this tag is now linked to "
"the task!\n"
"\n"
"Using the View menu, you can enable a sidebar which displays all the"
" tags you are using. This allows you to easily see all tasks "
"associated to a given tag.\n"
"\n"
"If you right-click on a tag in the sidebar, you can also edit it. It"
" allows you to assign it a color or an icon for instance. This is "
"handy if you want to quickly identify the tasks associated to a "
"given tag in the task list!\n\n"
"New tags are always added exclusively to the currently edited task, "
"and never to its subtasks. However, when you create a new subtask, "
"it will inherit its parent's tags.\n"
"\n"
"If you need a more advanced task organization, you can also create a"
" hierarchy of tags by drag-and-dropping a tag onto another. This "
"is useful when you want to regroup several tags together and see all"
" related tasks easily. For instance, if you have two tags @money and"
" @to_pay, and you drag @to_pay on @money, every task tagged with "
"@to_pay will also appear when you select @money.")
task3 = addtask(doc, "2@1", title3, text3, [])
root.appendChild(task3)
# Task 3@1: Using the Workview
title4 = _("Learn How To Use The Work View")
text4 = _(
"If you press the "Work View" button, only actionable tasks"
" will be displayed in your list.\n"
"\n"
"What is an actionable task? It's a task you can do directly, right "
"now.\n\n"
"It's a task that is already "start-able", i.e. the start "
"date is already over.\n"
"\n"
"It's a task that doesn't have open subtasks, i.e. you can do the "
"task itself directly.\n"
"\n"
"It's a task that has a due date different than "Someday", "
"since this kind of date is reserved for things that needs more "
"thoughts before being actionable.\n"
"\n"
"Thus, in short, the Work View shows you tasks that you can do right "
"now. It's very useful when you want to get things done and to focus "
"on the relevant tasks!\n"
"\n"
"If you use tags, you can right click on a tag in the sidebar and "
"choose to hide tasks assigned to this particular tag in the Work "
"View. It is very useful if you have a tag like "@wait" "
"that you use for tasks blocked by some external event (i.e. a phone "
"call you wait to receive).\n\n"
"And finally, an important note regarding the Work View: since the "
"Work View is updated instantaneously, if you edit your task while "
"using the Work View, this task might disappear due to the change you"
" just made (e.g. adding a subtask, adding a tag hidden in the Work "
"View, etc.). To avoid this, it's better not to edit your task while "
"using the Work View. ")
task4 = addtask(doc, "3@1", title4, text4, [])
root.appendChild(task4)
# Task 5@1: Plugins
title5 = _("Learn How To Use Plugins")
text5 = _(
"GTG has the ability to add plugins to extend its core functionality."
"\n\n"
"Some examples of the currently available plugins are the "
"notification icon which displays a handy shortcut to GTG in your "
"notification space, or the closed tasks remover which automatically "
"deletes old tasks from your closed tasks list.\n"
"\n"
"You can find the Plugin Manager by selecting Edit in the Menu Bar, "
"then clicking Plugins.")
task5 = addtask(doc, "4@1", title5, text5, [])
root.appendChild(task5)
# Task 5@1: Reporting bugs
title6 = _("Reporting Bugs")
text6 = _(
"GTG is still beta software. We like it and use it everyday but you "
"will probably encounter some bugs will you do.\n"
"\n"
"Please, help us improving GTG by reporting them on our Launchpad "
"page:https://bugs.launchpad.net/gtg/+filebug\n"
"\n"
"We need you to make this software better. Any contribution, any "
"idea is welcome!\n"
"\n"
"If you have some trouble with GTG, we might be able to help you or "
"to solve your problem really quickly.")
task6 = addtask(doc, "5@1", title6, text6, [])
root.appendChild(task6)
# Task 6@1: Learn how to use the QuickAdd Entry
title7 = _("Learn How To Use The Quick Add Entry")
text7 = _(
"The Quick Add Entry is the fastest way to create a new task. Use "
"the check box in the View menu to enable and disable the entry field"
".\n\n"
"To add a task simply type its title in the entry and press Enter. "
"The task will be created and selected in the task browser. If a tag "
"is selected in the Tags Sidebar, it will be applied to the task you "
"created.\n\n"
"You can also create a task in the Quick Add Entry and at the same "
"time specify its tags, due and defer date. Follow these format rules"
":\n\n"
"tags:tag1,tag2,tag3\n"
"\n"
"Using this you can apply as many tags as you wish using comma as "
"separator. Note that any word in the title that begins with ""
"@" will also be interpreted as a tag!\n"
"\n"
"due:date\n"
"defer:date\n"
"\n"
"Using this you can apply a due date or a defer date. Dates can be "
"formated as per your locale or yyyy-mm-dd (for example 2012-04-01) "
"or yyyymmdd (20120401) "
"or mmdd (0401 - the year being implicitly the current one) or today,"
" tomorrow or a weekday name (due:monday means due next Monday). "
"Dates which are added in this way will not appear in the task title."
"\n\n"
"Examples:\n"
"\n"
"buy stationary tags:purchases,office due:20120330 defer:tuesday\n"
"\n"
"The above example tells GTG to create a new task with the title "
""buy stationary", under the tags "purchases" "
"and "office", with the due date March 30, 2012 and the "
"start date next Tuesday.\n"
"\n"
"call mum tags:family,calls due:sunday defer:tomorrow\n"
"\n"
"The above example tells GTG to create a new task with the title "
""call mum", under the tags "family" and "
""calls", with the due date next Sunday and the start "
"date tomorrow.")
task7 = addtask(doc, "6@1", title7, text7, [])
root.appendChild(task7)
# Task 7@1: Learn How To Use Synchonization Services
title8 = _("Learn How To Use Synchronization Services")
text8 = _(
"Synchronization Services allow GTG to synchronize (meaning to have "
"access or to import) tasks, notes or bugs from other sites or "
"services like Launchpad, Remember the Milk, Tomboy, etc.\n"
"\n"
"This can incredibly useful if, for instance, you want to access your"
" tasks on several instances of GTG running on separate computers, or"
" if you want to edit your tasks using an online service. GTG can "
"also import tasks from specific sites like launchpad for instance, "
"which allows you to manage the bug reports you're working on in GTG!"
"\n\n"
"To use Synchronization Services, use the Edit menu, and select "
""Synchronization Services". You will then have the "
"possibility to select among several online or local services "
"from/to where you can import or export your tasks.\n"
"\n"
"If you want to know more about Synchronization Services, you can "
"read more about them by in the dedicated documentation in GTG's help"
" (use the Help menu or press F1 to get access to it).")
task8 = addtask(doc, "7@1", title8, text8, [])
root.appendChild(task8)
# Task 8@1: Learn How To Search For Tasks
title9 = _("Learn How To Search For Tasks")
text9 = _(
"To help you to find specific tasks more easily, GTG allows you to "
"search for tasks based on their content.\n"
"\n"
"Searching for tasks is really easy: just type the words you are "
"looking for in the Quick Add Entry, and select "Search" in"
" the menu that will appear automatically.\n"
"\n"
"GTG stores your searches in the sidebar, under the "Search"
"" section. You can thus always go back to a previous search "
"need it. Search results are updated automatically, so you always get"
" all the tasks matching your search request.\n"
"\n"
"GTG also saves all the search requests you have made until you "
"explicitely delete them (which you can do by right-clicking on them "
"and selecting "Delete"). That allows you to safely quit "
"GTG without loosing your search requests. This can be very useful "
"when you use the search features to identify specific tasks "
"regularly!\n\n"
"GTG search feature is really powerful and accept many parameters "
"that allows you to search for very specific tasks. For instance, "
"using the search query "@errands !today", you can search "
"for tasks with the @errands tag that must be done today. To learn "
"more about those search query parameters, you can read the "
"documentation available in GTG's help (press F1 or use the Help menu"
" to get access to it).")
task9 = addtask(doc, "8@1", title9, text9, [])
root.appendChild(task9)
return doc
