Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Form references[v52] #265

Open
wants to merge 4 commits into
base: maintenance/gramps51
Choose a base branch
from

Conversation

stevenyoungs
Copy link
Contributor

Teach the Form gramplet about form specific default references. The anticipated use is for a form to optionally provide template text in the reference attribute. This text is then shown in the form GUI Reference field for the user to complete to create a fully formed reference.

The PR is broken into 3 commits:

  1. read the new 'reference' attribute from the form XML file and store in the Form class
  2. display a forms reference in the GUI, but only for new forms
  3. add template references to a selection of forms defined in form_gb.xml

Fully backwards compatible with existing form definitions. If the reference attribute is missing from the form XML, existing behaviour is maintained.

@Nick-Hall
Copy link
Member

This seems like a good idea.

@sam-m888 sam-m888 changed the title Form references Form references[v52] Dec 27, 2019
@stevenyoungs
Copy link
Contributor Author

Source formatting adjusted to limit lines to 80 chars.
Copyrights added.

@stevenyoungs
Copy link
Contributor Author

Update documentation: https://gramps-project.org/wiki/index.php?title=Form_Addons
Amend the section "Writing your own form definitions"
Add a bullet point to describe the new "reference" element

  • reference: The default reference for this form. Optional.

How do I co-ordinate documentation updates with this PR / eventual release of the enhancement?

Form/form_gb.xml Outdated Show resolved Hide resolved
@stevenyoungs
Copy link
Contributor Author

Follow the format for WHERE_WITHIN_SOURCE in the GEDCOM specification
Add references for Welsh census.
Revised documentation change:

  • reference: The default reference for this form. It is strongly suggested to follow the format for WHERE_WITHIN_SOURCE in the GEDCOM specification. Optional.

The intended use it for the default reference to provide a template. For example for the UK1841 form, the default reference could be 'HO 107//, folio , page' which the user the completes to 'HO 107/782/6, folio 10, page 13'
Reference templates conform to the WHERE_WITHIN_SOURCE format of the GEDCOM 5.5.1 specification
…ates.

Note 1: In some cases the default reference fields are also included as heading fields. This is deliberate. If the existing heading fields are removed, any existing data in these fields will no longer display.
@Nick-Hall
Copy link
Member

This needs a rebase.

@stevenyoungs stevenyoungs changed the base branch from master to maintenance/gramps51 December 4, 2023 08:55
@stevenyoungs
Copy link
Contributor Author

@Nick-Hall : rebased onto maintenance/gramps51

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants