GEPS 022: Narrative Website Refactor

From Gramps
Revision as of 06:24, 23 November 2010 by Dsblank (Talk | contribs) (Created page with "This page documents a proposal to refactor Narrative Website into more manageable parts, and to create a more solid foundation going forward. = Narrative Website = Issues: # N...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This page documents a proposal to refactor Narrative Website into more manageable parts, and to create a more solid foundation going forward.

Narrative Website

Issues:

  1. Narrative Website (NarrWeb) is a very popular Gramps report among Gramps users
  2. NarrWeb perhaps has more reported bugs and issues than any other component of Gramps
  3. NarrWeb should give a complete and accurate rendering in a web browser, which has many complexities
  4. The size and complexity of the NarrWeb code has grown considerably since its initial version
  5. People consistently want NarrWeb to do even more
  6. NarrWeb is now monolithic and has many interacting, brittle parts
  7. There are needs for new features (such as object linking from notes) that require changes in NarrWeb

Because of these issues, a refactor is proposed. The main goals are:

  1. Break NarrWeb into manageable parts, each of which can be tested, refined, and replaced
  2. Move the complex, standard parts into a core that doesn't change as much, separate from more dynamic code
  3. Move to a two-pass, component driven process
  4. Reuse the Report plugin infrastructure for sub-components