Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
how_to:research_planner [2019/11/11 11:28]
ColeValleyGirl [Installing the Plugin]
how_to:research_planner [2019/12/06 09:41] (current)
ColeValleyGirl [Installing the Plugin]
Line 98: Line 98:
 ===== Installing the Plugin ===== ===== Installing the Plugin =====
  
-The Research Planner is currently downloaded via the FHUG forums but will be available from the Family Historian Plugin store after beta testing.+The Research Planner is available from the Family Historian Plugin store.
    
-When you run the plugin for the first time, it will check for the existence of an essential ​prerequisite ​and prompt you to install ​it if you haven'​t already done so: +When you run the plugin for the first time, it will check for the existence of two essential ​prerequisites ​and prompt you to install ​them if you haven'​t already done so: 
-  + 
-  ​* ​Support for the "pl module":​ pl is a library module used by many other plugins, so you may already have it installed. It will be downloaded if necessary from the Calico Pie website. +Support for the "pl module": ​ 
-  +  * pl is a library module used by many other plugins, so you may already have it installed. It will be downloaded if necessary from the Calico Pie website
-The first time the plugin runs (and the first time after any new version is installed), it will also check for the existence of this Help file and download the latest version if necessary. If for any reason, the Help File can't be downloaded, the plugin will continue to work (but without Help). ​**If the error persists**, you should download the Help zip file from [[http://​www.fhug.org.uk/​colevalleygirl/​Research Planner Help 2.0.zip|Research Planner Help 2.0.zip]] and extract its contents (a single directory) into the Research Planner plugin data directory: C:\Program Data\Calico Pie\Family Historian\Plugin Data\Research Planner.dat+  * Support for the "​zip"​ module: zip is a library module used to extract zip files. It will be downloaded if necessary from the Calico Pie website. 
 + 
 +Users of Crossover, PlayOnLinux/​MAC and Wine should consult the [[how_to:​family_historian_v6_on_crossover_wine#​plugin_library_modules|instructions]] for installing these libraries in their environment
 + 
 +The first time the plugin runs (and the first time after any new version is installed), it will also check for the existence of this Help file and download the latest version if necessary ​(as a zip file which it extracts into a sub-directory under your Plugin data folder). If for any reason, the Help File can't be downloaded, the plugin will continue to work (but without Help). 
 + 
 +If the error persists, you should download the Help zip file from [[http://​www.fhug.org.uk/​colevalleygirl/​Research Planner Help 2.0.zip|Research Planner Help 2.0.zip]] and extract its contents (a single directory) into the Research Planner plugin data directory: C:\Program Data\Calico Pie\Family Historian\Plugin Data\Research Planner.dat ​ or its equivalent in your environment (documented at [[glossary:​family_historian_program_data_folder|Family Historian Program Data Folder]]). ​ (You may need to tell File Explorer to show hidden files to be able to see this folder). ​ This manual extraction may also be necessary if you're running within a Crossover, PlayOnLinux/​Mac or Wine environment.
    
 The first time version 2 of the Plugin runs it will prompt you for your chosen Options. The first time version 2 of the Plugin runs it will prompt you for your chosen Options.
Line 161: Line 167:
    
 == Field5 == == Field5 ==
-This is a multiline field, as long as you like.  By default ​is is called Notes, but you can choose to rename it to e.g. Progress. ​ Recommended (default) value is ON as this is where you will record the progress and results of your task.+This is a multiline field, as long as you like.  By default ​it is called Notes, but you can choose to rename it to e.g. Progress. ​ Recommended (default) value is ON as this is where you will record the progress and results of your task.
    
 == Fact Date == == Fact Date ==
Line 259: Line 265:
 ==== Converting between Facts and Notes ==== ==== Converting between Facts and Notes ====
  
-The Research Planner allows you to convert Tasks stored as Notes Tasks stored as Facts, and vice versa (use the Convert button on the Tools tab). If you've configured the plugin to use Notes, you'll be able to Convert To Facts by specifying a Tag to include in the resultant Notes); if you've configured the plugin to use Facts, you'll be able to convert Notes to Facts by specifying a Tag to identify the notes.+The Research Planner allows you to convert Tasks stored as Notes into Tasks stored as Facts, and vice versa (use the Convert button on the Tools tab). If you've configured the plugin to use Notes, you'll be able to Convert To Facts by specifying a Tag to include in the resultant Notes); if you've configured the plugin to use Facts, you'll be able to convert Notes to Facts by specifying a Tag to identify the notes.
    
 In both cases, you'll be offered the option to delete the originals once the conversion has taken place. ​ Conversion should not result in the loss of any data.  However, it is recommended that you run the conversion without selecting the delete option and check that the results are as you would wish; the plugin will exit after conversion and display results the original and new records for you to check. Once you're happy, you can delete the original records from the results window; or you can undo the plugin edits and rerun the conversion with the delete option selected. In both cases, you'll be offered the option to delete the originals once the conversion has taken place. ​ Conversion should not result in the loss of any data.  However, it is recommended that you run the conversion without selecting the delete option and check that the results are as you would wish; the plugin will exit after conversion and display results the original and new records for you to check. Once you're happy, you can delete the original records from the results window; or you can undo the plugin edits and rerun the conversion with the delete option selected.
Line 479: Line 485:
 Make Tasks from the selected Templates. Make Tasks from the selected Templates.
    
-Note: If you've configured the plugin ​ot include one or more dates in your tasks, they will be set as follows:+Note: If you've configured the plugin ​to include one or more dates in your tasks, they will be set as follows:
    
 Update Date: Today Update Date: Today
Line 510: Line 516:
 == 5. Options button == == 5. Options button ==
    
-Option ​the plugin Options dialog.+Open the plugin Options dialog.
  
 == 6. Exit button == == 6. Exit button ==
Line 546: Line 552:
 ==== Family Historian Edit > Find ==== ==== Family Historian Edit > Find ====
    
-If you have Family Historian 6, the menu item Edit > Find will allow you so search for a tag (remember to prefix it here with a #) within specified records and field types. It displays more summarised results than the Research Planner Find Items facility but does allow you to constrain what is searched.+If you have Family Historian 6, the menu item Edit > Find will allow you to search for a tag (remember to prefix it here with a #) within specified records and field types. It displays more summarised results than the Research Planner Find Items facility but does allow you to constrain what is searched.
 ===== Reporting ===== ===== Reporting =====
  
 The facilities available in Family Historian 6 do not make reporting on Research Tasks as flexible or well laid out as I would wish. The facilities available in Family Historian 6 do not make reporting on Research Tasks as flexible or well laid out as I would wish.
    
-If using Facts, from the Tools tab  can download a report Tasks - Individual (Facts) which will display ALL Tasks (without filtering) for a list of Individuals.+If using Facts, from the Tools tab you can download a report Tasks - Individual (Facts) which will display ALL Tasks (without filtering) for a list of Individuals.
    
 If using Notes you can download a report Tasks - Individual (Notes) from the same place, which will display ALL Notes (not just Research Task Notes) for a list on Individuals. If using Notes you can download a report Tasks - Individual (Notes) from the same place, which will display ALL Notes (not just Research Task Notes) for a list on Individuals.