Difference between revisions of "3.1 Roadmap"

From Gramps
Jump to: navigation, search
m (Documentation)
(18 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:Developers/General]][[Category:Developers/Roadmap]]
 
 
 
The next version 3.1 of GRAMPS will include new features, not just bug fixes.
 
The next version 3.1 of GRAMPS will include new features, not just bug fixes.
  
 
==Towards 3.1==
 
==Towards 3.1==
Development of version 3.1 is well under way. Trunk (3.1) is not far from the gramps30 branch.
+
 
 +
=== Schedule ===
 +
* February 7: Final day for feature changes.
 +
* February 8 - February 14: Developers are encouraged to focus on code clean up. Find your favorite files and document them better, make them more PEP8 compliant and break them into smaller files if necessary. This is a good time to rename classes/function/variables that need it. If you can't think of anything to do, grab a random file and work to give it a better pylint score.
 +
* February 15: Create the 3.1 maintenance branch (gramps31). Any incomplete features will be disabled or commented out in the gramps31 branch so as not to hold up the release.
 +
* February 15 - February 28: Bug fix! We will manage the blocking bugs on the Mantis roadmap as usual. Bugs should be fixed in the gramps31 branch and merged into trunk.
 +
* March 1: Release GRAMPS 3.1.0 - assuming all bugs on the roadmap are fixed. This date will be delayed if there are still blocking bugs in Mantis.
 +
 
 +
=== Notes to Users ===
 +
* Reference count filters in non English language must be remade [http://www.gramps-project.org/bugs/view.php?id=2700], if not they will now match on objects with 0 references.
 +
* Markup in the Notes is not yet present in all output formats, the ones missing will be added in later point updates
 +
* Some advanced Gramplets and plugins have been removed. If you miss one you where used to, check [http://www.gramps-project.org/wiki/index.php?title=Third-party_Plugins this page] to download them manually.
  
 
=== New Major Features ===
 
=== New Major Features ===
Line 10: Line 19:
 
* New reports: records [Reinhard], Place [Gary] [http://www.gramps-project.org/bugs/view.php?id=2079 #2079]
 
* New reports: records [Reinhard], Place [Gary] [http://www.gramps-project.org/bugs/view.php?id=2079 #2079]
 
* New tool: Sort Event [Gary]
 
* New tool: Sort Event [Gary]
* Notes with markup (bold, italic, underline, fontface, fontsize, fontcolor, highlight, superscript) [Zsolt]
+
* Notes with markup (bold, italic, underline, fontface, fontsize, fontcolor, highlight, superscript) [Zsolt], support for markup in pdf, print, latex backends (Benny)
 
* Date changes: indication of new year, dual date, calculate age improvements, better slash date support, better calendar support on reports [Doug] (see [[Dates]] => ''changes on gen/lib and DB update'') [http://www.gramps-project.org/bugs/view.php?id=1834 #1834], [http://www.gramps-project.org/bugs/view.php?id=2260 #2260], [http://www.gramps-project.org/bugs/view.php?id=1842 #1842], [http://www.gramps-project.org/bugs/view.php?id=1834 #1834], [http://www.gramps-project.org/bugs/view.php?id=2045 #2045]
 
* Date changes: indication of new year, dual date, calculate age improvements, better slash date support, better calendar support on reports [Doug] (see [[Dates]] => ''changes on gen/lib and DB update'') [http://www.gramps-project.org/bugs/view.php?id=1834 #1834], [http://www.gramps-project.org/bugs/view.php?id=2260 #2260], [http://www.gramps-project.org/bugs/view.php?id=1842 #1842], [http://www.gramps-project.org/bugs/view.php?id=1834 #1834], [http://www.gramps-project.org/bugs/view.php?id=2045 #2045]
  
 
=== Other Features ===
 
=== Other Features ===
 
* Experimental HtmlView and [[GeoView]]. This will not be visible to the user as the code is experimental, but can be activated easily by the user by changing the keys.ini file [Serge, Benny]. [http://www.gramps-project.org/bugs/view.php?id=1551 #1551]
 
* Experimental HtmlView and [[GeoView]]. This will not be visible to the user as the code is experimental, but can be activated easily by the user by changing the keys.ini file [Serge, Benny]. [http://www.gramps-project.org/bugs/view.php?id=1551 #1551]
* Filters [Benny, Peter, Jérôme, Michiel]: [http://www.gramps-project.org/bugs/view.php?id=2465 #2465], [http://www.gramps-project.org/bugs/view.php?id=2603 #2603]
+
* Filters [Benny, Peter, Jérôme, Michiel, Gary]: [http://www.gramps-project.org/bugs/view.php?id=2465 #2465], [http://www.gramps-project.org/bugs/view.php?id=2603 #2603]
 
** New Bases for rules (HasGallery, HasLDS, HasNote, HasSource, ChangedSince)
 
** New Bases for rules (HasGallery, HasLDS, HasNote, HasSource, ChangedSince)
 
** Counter on rules using Base (lesser than, greater than, equal to <n>)
 
** Counter on rules using Base (lesser than, greater than, equal to <n>)
** New rules on primary objects : Event/_HasGallery.py, Event/_HasNote.py, Event/_ChangedSince.py, Family/_HasSource.py, Family/_HasGallery.py, Family/_HasNote.py, Family/_HasLDS.py, Family/_ChangedSince.py, Person/_HasGallery.py (update), Person/_HasSource.py, Person/_HasNote.py (update), Person/_HasLDS.py, Person/_HasAddress.py, Person/_HasAssociation.py, Person/_ChangedSince.py, Person/_NoBirthdate.py, Place/_HasGallery.py, Place/_HasNote.py, Place/_ChangedSince.py, Source/_HasGallery.py, Source/_HasNote.py, Source/_ChangedSince.py, MediaObject/_ChangedSince.py, Note/_ChangedSince.py, Repository/_ChangedSince.py
+
** New rules on primary objects : Event/_HasGallery.py, Event/_HasNote.py, Event/_ChangedSince.py, Event/_HasAttribute.py, Event/_HasData.py, Family/_HasSource.py, Family/_HasGallery.py, Family/_HasNote.py, Family/_HasLDS.py, Family/_ChangedSince.py, MediaObject/_HasAttribute.py, Person/_HasGallery.py (update), Person/_HasSource.py, Person/_HasNote.py (update), Person/_HasLDS.py, Person/_HasAddress.py, Person/_HasAssociation.py, Person/_ChangedSince.py, Person/_NoBirthdate.py, Place/_HasGallery.py, Place/_HasNote.py, Place/_ChangedSince.py, Place/_HasPlace.py (can now search by street), Source/_HasGallery.py, Source/_HasNote.py, Source/_ChangedSince.py, MediaObject/_ChangedSince.py, Note/_ChangedSince.py, Repository/_ChangedSince.py
* experimental SQLite export [Doug ?]
 
 
* privacy: proxy Note filter (GRAMPS XML, GPKG, GEDCOM, SQLite) [Brian, Robert] [http://www.nabble.com/Gramps-db-proxys-td18497400.html nabble], [http://sourceforge.net/mailarchive/forum.php?thread_name=487E6CE6.3030308%40cheramy.net&forum_name=gramps-devel archives]
 
* privacy: proxy Note filter (GRAMPS XML, GPKG, GEDCOM, SQLite) [Brian, Robert] [http://www.nabble.com/Gramps-db-proxys-td18497400.html nabble], [http://sourceforge.net/mailarchive/forum.php?thread_name=487E6CE6.3030308%40cheramy.net&forum_name=gramps-devel archives]
 +
* unlinked objects proxy: prevents Gramps from exporting objects that are not linked to people filtered for export. [Gary]
 
* Add "Export View..." action on Note View [http://www.gramps-project.org/bugs/view.php?id=2607 #2607]
 
* Add "Export View..." action on Note View [http://www.gramps-project.org/bugs/view.php?id=2607 #2607]
* Allow "Full screen" size [Gary]
+
* Smaller windows, "Full screen" size and other UI changes to improve usability on netbooks. [Gary, Benny, and Doug]
 
* New preference tabs, displays/manages keys related to dates (still present on .gramps/keys.ini) and displays/manages 'internet maps' for GeoView [Doug, Serge, Benny, ...] [http://www.gramps-project.org/bugs/view.php?id=2291 #2291], [http://www.gramps-project.org/bugs/view.php?id=1551 #1551]
 
* New preference tabs, displays/manages keys related to dates (still present on .gramps/keys.ini) and displays/manages 'internet maps' for GeoView [Doug, Serge, Benny, ...] [http://www.gramps-project.org/bugs/view.php?id=2291 #2291], [http://www.gramps-project.org/bugs/view.php?id=1551 #1551]
 
* Calculate age on Relationships View [Doug]
 
* Calculate age on Relationships View [Doug]
 
* Move 'View' category to 'text' category or Tools [Brian]
 
* Move 'View' category to 'text' category or Tools [Brian]
* Move NotRelated from Report -> View to tool [Brian]
+
* Narrated Web improvements: xhtml support, [Stéphane, ...]
* New plugin management [Brian]
+
* Web Calendar improvements: xhtml support, year glance, partial year, [...]
* Narrated Web improvements [Stéphane, ...]
 
* Web Calendar improvements [...]
 
 
* Christening event on Detailed reports (like baptism) [Brian] [http://www.gramps-project.org/bugs/view.php?id=2467 #2467]
 
* Christening event on Detailed reports (like baptism) [Brian] [http://www.gramps-project.org/bugs/view.php?id=2467 #2467]
 
* 'Unused objects' tool supports Note objects [Gary] [http://www.gramps-project.org/bugs/view.php?id=1512 #1512], [http://www.gramps-project.org/bugs/view.php?id=2055 #2055]
 
* 'Unused objects' tool supports Note objects [Gary] [http://www.gramps-project.org/bugs/view.php?id=1512 #1512], [http://www.gramps-project.org/bugs/view.php?id=2055 #2055]
 +
* NotRelated moves from Report -> View  to Tools->Utilities [Brian]
 +
* To reload plugin is now on "plugin status" dialog [Brian]
 +
* Changes on "Uncollected objects" tool [Gary]
 +
* Changed/new map services [Benny, Peter]
 +
* Changes on report framework:
 +
** Style and ListOptions improvements [Craig J., Brian]
 +
** Document options (output) is now at the bottom of dialog. [Brian]
 +
** Split and move MenuOptions from /PluginUtils to gen/plug/menu [Brian]
 +
** Categorize /plugins/ to multiples directories (export, import, tool, textreport, etc ...) [Brian]
 +
* translations: plural forms support [Josip, Jérôme, Benny] [http://www.gramps-project.org/bugs/view.php?id=1718 #1718], [http://www.gramps-project.org/bugs/view.php?id=2657 #2657]
 +
 +
Plugins not (or no longer) distributed, but available from subversion and 3th party wiki page :
 +
* experimental SQLite export [Doug ?]
 +
* advanced gramplets: python, log [TODO]
 +
* ...
  
 
=== Documentation ===
 
=== Documentation ===
* need to upgrade { { man index } } and { { man index/locale } } form 3.0 to 3.1
+
* need to upgrade index number on [http://www.gramps-project.org/wiki/index.php?title=Template:Man_index { { man index } }] and { { man index/locale } } form 3.0 to 3.1 (stable release)
 
* ''TODO'': make documentation for '''Order Events''' tool, and '''Place report'''.
 
* ''TODO'': make documentation for '''Order Events''' tool, and '''Place report'''.
 
* ''TODO'': update Note editor paragraph with markup support.
 
* ''TODO'': update Note editor paragraph with markup support.
 
* ''TODO'': informations on new filters
 
* ''TODO'': informations on new filters
 +
* ''TODO'': update [[Coding_for_translation|Coding translation]] and [[Translating_GRAMPS|Translating GRAMPS]].
 +
* ''TODO'': go over the tips of the day xml file, add new tips, remove no longer valid ones.
 
* Translations:  
 
* Translations:  
 
** Changes on [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Main_Window&action=history Main Window page].
 
** Changes on [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Main_Window&action=history Main Window page].
 
** Changes on [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed&action=history  Detailed edition page].
 
** Changes on [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Entering_and_Editing_Data:_Detailed&action=history  Detailed edition page].
 
** Changes on [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Gramplets&action=history Gramplets page].
 
** Changes on [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Gramplets&action=history Gramplets page].
** [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Reports#Records_Report Records report] has been added (=> translations ?)
+
** Changes on [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_FAQ&action=history FAQ]
 +
** Changes on [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Reports&action=history Reports]
 +
** [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Reports#Records_Report Records report] has been added
 +
** Change the wiki Screenshots ?
 +
 
  
 
=== Testing ===
 
=== Testing ===
 
* Double check that for all database changes (dates, note markup, etc) that the upgrade works properly, XML import/export plugins have been updated and that the DTD is updated.
 
* Double check that for all database changes (dates, note markup, etc) that the upgrade works properly, XML import/export plugins have been updated and that the DTD is updated.
 +
* ''TODO'': Run the test suite
 +
* ''TODO'': Make sure the links in 3.0 are all moved to 3.1 --> do search on string 3.0 in the code. Make sure the third party plugins page points to the 3.1 plugins, not the 3.0 plugins!
  
 
==General TODO List==
 
==General TODO List==
  
 
* What about preformatted notes ??
 
* What about preformatted notes ??
 +
 +
[[Category:Developers/General]]
 +
[[Category:Developers/Roadmap]]

Revision as of 22:37, 22 December 2010

The next version 3.1 of GRAMPS will include new features, not just bug fixes.

Towards 3.1

Schedule

  • February 7: Final day for feature changes.
  • February 8 - February 14: Developers are encouraged to focus on code clean up. Find your favorite files and document them better, make them more PEP8 compliant and break them into smaller files if necessary. This is a good time to rename classes/function/variables that need it. If you can't think of anything to do, grab a random file and work to give it a better pylint score.
  • February 15: Create the 3.1 maintenance branch (gramps31). Any incomplete features will be disabled or commented out in the gramps31 branch so as not to hold up the release.
  • February 15 - February 28: Bug fix! We will manage the blocking bugs on the Mantis roadmap as usual. Bugs should be fixed in the gramps31 branch and merged into trunk.
  • March 1: Release GRAMPS 3.1.0 - assuming all bugs on the roadmap are fixed. This date will be delayed if there are still blocking bugs in Mantis.

Notes to Users

  • Reference count filters in non English language must be remade [1], if not they will now match on objects with 0 references.
  • Markup in the Notes is not yet present in all output formats, the ones missing will be added in later point updates
  • Some advanced Gramplets and plugins have been removed. If you miss one you where used to, check this page to download them manually.

New Major Features

  • Many new Gramplets [Doug, Reinhard, ....]
  • New reports: records [Reinhard], Place [Gary] #2079
  • New tool: Sort Event [Gary]
  • Notes with markup (bold, italic, underline, fontface, fontsize, fontcolor, highlight, superscript) [Zsolt], support for markup in pdf, print, latex backends (Benny)
  • Date changes: indication of new year, dual date, calculate age improvements, better slash date support, better calendar support on reports [Doug] (see Dates => changes on gen/lib and DB update) #1834, #2260, #1842, #1834, #2045

Other Features

  • Experimental HtmlView and GeoView. This will not be visible to the user as the code is experimental, but can be activated easily by the user by changing the keys.ini file [Serge, Benny]. #1551
  • Filters [Benny, Peter, Jérôme, Michiel, Gary]: #2465, #2603
    • New Bases for rules (HasGallery, HasLDS, HasNote, HasSource, ChangedSince)
    • Counter on rules using Base (lesser than, greater than, equal to <n>)
    • New rules on primary objects : Event/_HasGallery.py, Event/_HasNote.py, Event/_ChangedSince.py, Event/_HasAttribute.py, Event/_HasData.py, Family/_HasSource.py, Family/_HasGallery.py, Family/_HasNote.py, Family/_HasLDS.py, Family/_ChangedSince.py, MediaObject/_HasAttribute.py, Person/_HasGallery.py (update), Person/_HasSource.py, Person/_HasNote.py (update), Person/_HasLDS.py, Person/_HasAddress.py, Person/_HasAssociation.py, Person/_ChangedSince.py, Person/_NoBirthdate.py, Place/_HasGallery.py, Place/_HasNote.py, Place/_ChangedSince.py, Place/_HasPlace.py (can now search by street), Source/_HasGallery.py, Source/_HasNote.py, Source/_ChangedSince.py, MediaObject/_ChangedSince.py, Note/_ChangedSince.py, Repository/_ChangedSince.py
  • privacy: proxy Note filter (GRAMPS XML, GPKG, GEDCOM, SQLite) [Brian, Robert] nabble, archives
  • unlinked objects proxy: prevents Gramps from exporting objects that are not linked to people filtered for export. [Gary]
  • Add "Export View..." action on Note View #2607
  • Smaller windows, "Full screen" size and other UI changes to improve usability on netbooks. [Gary, Benny, and Doug]
  • New preference tabs, displays/manages keys related to dates (still present on .gramps/keys.ini) and displays/manages 'internet maps' for GeoView [Doug, Serge, Benny, ...] #2291, #1551
  • Calculate age on Relationships View [Doug]
  • Move 'View' category to 'text' category or Tools [Brian]
  • Narrated Web improvements: xhtml support, [Stéphane, ...]
  • Web Calendar improvements: xhtml support, year glance, partial year, [...]
  • Christening event on Detailed reports (like baptism) [Brian] #2467
  • 'Unused objects' tool supports Note objects [Gary] #1512, #2055
  • NotRelated moves from Report -> View to Tools->Utilities [Brian]
  • To reload plugin is now on "plugin status" dialog [Brian]
  • Changes on "Uncollected objects" tool [Gary]
  • Changed/new map services [Benny, Peter]
  • Changes on report framework:
    • Style and ListOptions improvements [Craig J., Brian]
    • Document options (output) is now at the bottom of dialog. [Brian]
    • Split and move MenuOptions from /PluginUtils to gen/plug/menu [Brian]
    • Categorize /plugins/ to multiples directories (export, import, tool, textreport, etc ...) [Brian]
  • translations: plural forms support [Josip, Jérôme, Benny] #1718, #2657

Plugins not (or no longer) distributed, but available from subversion and 3th party wiki page :

  • experimental SQLite export [Doug ?]
  • advanced gramplets: python, log [TODO]
  • ...

Documentation


Testing

  • Double check that for all database changes (dates, note markup, etc) that the upgrade works properly, XML import/export plugins have been updated and that the DTD is updated.
  • TODO: Run the test suite
  • TODO: Make sure the links in 3.0 are all moved to 3.1 --> do search on string 3.0 in the code. Make sure the third party plugins page points to the 3.1 plugins, not the 3.0 plugins!

General TODO List

  • What about preformatted notes ??