Software Requirements

GHOSTS requirements

REQ_GHOSTS_1

GHOSTS shall manage standard Genealogical Data file format

Lower level requirements:

• REQ_LIBGEDCOMPARSER_1 - libgedcomparser shall provide a data structure to handle genealogical data
• REQ_LIBGEDCOMPARSER_2 - libgedcomparser shall provide services to upload a GEDCOM 5.5 file into its data structure
• REQ_LIBGEDCOMPARSER_3 - libgedcomparser shall provide services to dump its data structure into a GEDCOM 5.5 file 
• REQ_LIBGEDCOMPARSER_ 10 - libgedcomparser shall provide services to modify genealogical data. Advanced services, assuring data integrity, shall be provided for the following operations:
• add an invidual record
• add a family record linked to an individual record, in which the individual record is spouse
• add a family record linked to an individual record, in which the individual record is child
• define the first name and the last name of an individual record
• define the date and place for birth and death event of an individual record
• define the date and place for marriage event of a family record
• REQ_GEDCOMVIEWER_1 - gedcomviewer shall display the following information:
• individual's first name 
• individual's last name
• individual's occupation
• individual's sex
• individual's birth date and place
• individual's death date and place
• individual's parents
• individual's spouses
• individual's children
• individual's marriage date and place
• individual's list of events, consisting in event label, dates and places
• GEDCOM file description
• GEDCOM file source name
• REQ_GEDCOMVIEWER_2 - gedcomviewer shall allow modification of the following information:
• individual's first name 
• individual's last name
• individual's occupation
• individual's sex
• individual's birth date and place
• individual's death date and place
• individual's parents
• individual's spouses
• individual's children
• individual's marriage date and place
• GEDCOM file description
• GEDCOM file source name

REQ_GHOSTS_2

GHOSTS shall be consistent with GNU standards

Lower level requirements:

• REQ_LIBGEDCOMPARSER_ 8 - The 'gedcomcheck' utility shall be sensitive to the following standards GNU options :
• -v or --version : give the version of libgedcomparser associated to gedcomcheck
• -h or --help : give the available options of gedcomcheck
• REQ_GEDCOMVIEWER_3 - gedcomviewer man machine interface shall be consistent with GNOME environment

REQ_GHOSTS_3

GHOSTS shall support internationalization ; at least English and French languages shall be available

Lower level requirements:

• REQ_LIBGEDCOMPARSER_ 9 - All libgedcomparser messages outputs shall support internationalization ; at least English and French languages shall be available
• REQ_GEDCOMVIEWER_6 - gedcomviewer man machine interface shall support internationalization ; at least English and French languages shall be available

REQ_GHOSTS_4

GHOSTS shall provide a command line tool to check validity of GEDCOM 5.5 files

Lower level requirements:

• REQ_LIBGEDCOMPARSER_ 5 - The 'gedcomcheck' utility shall exit with status '0' if an error occurs during GEDCOM 5.5 parsing (bad file format, file not found)

REQ_GHOSTS_5

GHOSTS shall provide a command line tool to provide metrics about GEDCOM 5.5 files

Lower level requirements:

• REQ_LIBGEDCOMPARSER_ 6 - The 'gedcomcheck' utility shall display metrics about GEDCOM 5.5 data input : number of individual records, number of family records ; those metrics shall be provided on user request

REQ_GHOSTS_6

GHOSTS shall provide a graphical tool to display genealogical data

Lower level requirements:

• REQ_GEDCOMVIEWER_ 1 - gedcomviewer shall display the following information:
• individual's first name 
• individual's last name
• individual's occupation
• individual's sex
• individual's birth date and place
• individual's death date and place
• individual's parents
• individual's spouses
• individual's children
• individual's marriage date and place
• individual's list of events, consisting in event label, dates and places
• GEDCOM file description
• GEDCOM file source name
• REQ_GEDCOMVIEWER_ 4 - gedcomviewer shall provide a way to browse individuals within the genealogical data structure

REQ_GHOSTS_7

GHOSTS shall provide a graphical tool to define / update GEDCOM genealogical data

Lower level requirements:

• REQ_GEDCOMVIEWER_ 2 - gedcomviewer shall allow modification of the following information:
• individual's first name 
• individual's last name
• individual's occupation
• individual's sex
• individual's birth date and place
• individual's death date and place
• individual's parents
• individual's spouses
• individual's children
• individual's marriage date and place
• GEDCOM file description
• GEDCOM file source name

REQ_GHOSTS_8

GHOSTS shall provide services to select particular records within a set of genealogical data

GEDCOMPARSER requirements

REQ_LIBGEDCOMPARSER_1

libgedcomparser shall provide a data structure to handle genealogical data

Upper level requirements:

• REQ_GHOSTS_1 - GHOSTS shall manage standard Genealogical Data file format

REQ_LIBGEDCOMPARSER_2

libgedcomparser shall provide services to upload a GEDCOM 5.5 file into its data structure

Upper level requirements:

• REQ_GHOSTS_1 - GHOSTS shall manage standard Genealogical Data file format

REQ_LIBGEDCOMPARSER_3

libgedcomparser shall provide services to dump its data structure into a GEDCOM 5.5 file

Upper level requirements:

• REQ_GHOSTS_1 - GHOSTS shall manage standard Genealogical Data file format

REQ_LIBGEDCOMPARSER_4

The 'gedcomcheck' utility included in libgedcomparser shall be able to parse GEDCOM 5.5 files

Upper level requirements:

• REQ_GHOSTS_4 - GHOSTS shall provide a command line tool to check validity of GEDCOM 5.5 files

REQ_LIBGEDCOMPARSER_5

The 'gedcomcheck' utility shall exit with status '0' if an error occurs during GEDCOM 5.5 parsing (bad file format, file not found)

Upper level requirements:

• REQ_GHOSTS_4 - GHOSTS shall provide a command line tool to check validity of GEDCOM 5.5 files

REQ_LIBGEDCOMPARSER_6

The 'gedcomcheck' utility shall display metrics about GEDCOM 5.5 data input : number of individual records, number of family records ; those metrics shall be provided on user request

Upper level requirements:

• REQ_GHOSTS_5 - GHOSTS shall provide a command line tool to provide metrics about GEDCOM 5.5 files

REQ_LIBGEDCOMPARSER_7

The 'gedcomcheck' utility shall report the execution trace of the GEDCOM 5.5 parsing process ; this execution trace report shall be provided on user request.

Upper level requirements:

• NONE - this requirement is introduced to easy analysis when an error occurs during the parsing of a file declared compliant to GEDCOM 5.5 format

REQ_LIBGEDCOMPARSER_8

The 'gedcomcheck' utility shall be sensitive to the following standards GNU options :

-v or --version : give the version of libgedcomparser associated to gedcomcheck

-h or --help : give the available options of gedcomcheck

Upper level requirements:

• REQ_GHOSTS_2 - GHOSTS shall be consistent with GNU standards

REQ_LIBGEDCOMPARSER_9

All libgedcomparser messages outputs shall support internationalization ; at least English and French languages shall be available

Upper level requirements:

• REQ_GHOSTS_3 - GHOSTS shall support internationalization ; at least English and French languages shall be available

REQ_LIBGEDCOMPARSER_10

libgedcomparser shall provide services to modify genealogical data. Advanced services, assuring data integrity, shall be provided for the following operations:

• add an individual record
• add a family record linked to an individual record, in which the individual record is spouse
• add a family record linked to an individual record, in which the individual record is child
• define the first name and the last name of an individual record
• define the date and place for birth and death event of an individual record
• define the date and place for marriage event of a family record

Upper level requirements:

• REQ_GHOSTS_1 - GHOSTS shall manage standard Genealogical Data file format

REQ_LIBGEDCOMPARSER_11

libgedcomparser shall provide a way to select individual without children in a set of genealogical data

Upper level requirements:

• REQ_GHOSTS_8 - GHOSTS shall provide services to select particular records within a set of genealogical data

REQ_LIBGEDCOMPARSER_12

libgedcomparser shall provide a way to select individual without spouse in a set of genealogical data

Upper level requirements:

• REQ_GHOSTS_8 - GHOSTS shall provide services to select particular records within a set of genealogical data

REQ_LIBGEDCOMPARSER_13

libgedcomparser shall provide a way to select individual of a particular gender (male or female) in a set of genealogical data

Upper level requirements:

• REQ_GHOSTS_8 - GHOSTS shall provide services to select particular records within a set of genealogical data

REQ_LIBGEDCOMPARSER_14

libgedcomparser shall provide a way to select individual without parents in a set of genealogical data

Upper level requirements:

• REQ_GHOSTS_8 - GHOSTS shall provide services to select particular records within a set of genealogical data

GEDCOMVIEWER requirements

REQ_GEDCOMVIEWER_1

gedcomviewer shall display the following information:

• individual's first name 
• individual's last name
• individual's occupation
• individual's sex
• individual's birth date and place
• individual's death date and place
• individual's parents
• individual's spouses
• individual's children
• individual's marriage date and place
• individual's list of events, consisting in event label, dates and places
• GEDCOM file description
• GEDCOM file source name

Upper level requirements:

• REQ_GHOSTS_1 - GHOSTS shall manage standard Genealogical Data file format
• REQ_GHOSTS_6 - GHOSTS shall provide a graphical tool to display genealogical data

REQ_GEDCOMVIEWER_2

gedcomviewer shall allow modification of the following information:

• individual's first name 
• individual's last name
• individual's occupation
• individual's sex
• individual's birth date and place
• individual's death date and place
• individual's parents
• individual's spouses
• individual's children
• individual's marriage date and place
• GEDCOM file description
• GEDCOM file source name

Upper level requirements:

• REQ_GHOSTS_1 - GHOSTS shall manage standard Genealogical Data file format
• REQ_GHOSTS_7 - GHOSTS shall provide a graphical tool to define / update GEDCOM genealogical data

REQ_GEDCOMVIEWER_3

gedcomviewer man machine interface shall be consistent with GNOME environment

Upper level requirements:

• REQ_GHOSTS_2 - GHOSTS shall be consistent with GNU standards

REQ_GEDCOMVIEWER_4

gedcomviewer shall provide a way to browse individuals within the genealogical data structure

Upper level requirements:

• REQ_GHOSTS_1 - GHOSTS shall manage standard Genealogical Data file format
• REQ_GHOSTS_6 - GHOSTS shall provide a graphical tool to display genealogical data

REQ_GEDCOMVIEWER_4_1

gedcomviewer shall give a way to browse through the list of individuals of the genealogical data structure.
If the user changes the current selected individu in the list, the new selected individu shall be displayed in the application window.
If the user changes the current displayed individu in the application window, the new displayed individu shall be selected in the list.
Modifications of the genealogical data structure shall be automatically and simultaneously reflected in the list.

REQ_GEDCOMVIEWER_4_2

gedcomviewer shall give a way to browse through a tree of individuals of the genealogical data structure
The root of the tree shall be the current individu displayed in the application window when the user asks for the tree browsing feature.
If the user changes the current selected individu in the tree, the new selected individu shall be displayed in the application window.
If the user changes the current displayed individu in the application window, the new displayed individu shall be selected in the tree ; if the individu to be displayed is not included in the tree (i.e. the new displayed individu in the application window is not an ancestor of the root individu in the tree), then no individu shall be selected in the tree.
Modifications of the genealogical data structure shall be automatically and simultaneously reflected in the tree.

REQ_GEDCOMVIEWER_5

if an information is displayed on many man machine interface elements, all the elements shall be consistent at any time (in case of modification through one element, the others shall be systematically updated to reflect modification)

Upper level requirements:

• NONE - this requirement is introduced to trace the required behavior since gedcomviewer is implemented as a Multiple Document Interface application

REQ_GEDCOMVIEWER_6

gedcomviewer man machine interface shall support internationalization ; at least English and French languages shall be available

Upper level requirements:

• REQ_GHOSTS_3 - GHOSTS shall support internationalization ; at least English and French languages shall be available

REQ_GEDCOMVIEWER_7

gedcomviewer shall give the availability to open many GEDCOM files simultaneously

Upper level requirements:

• NONE - this requirement is introduced to trace the required behavior since gedcomviewer is implemented as a Multiple Document Interface application