Files
transcription/docs/Proposed Revisions to V4.md
T

5.0 KiB

Proposed Revisions

This document contains a list of proposed fixes, adjustments, and additional features. Consider whether each change provides a real improvement, is practical to implement, and whether or not it introduces unnecessary complexity and make recommendations.

Also, consider whether these changes should be implemented in more than one revision. For example, some might be considered Version 4.1 revisions, some might be Version 5, and some might be saved for a future date after I've had time to use the app for a while.

UI

Most of the proposed changes to the UI are cosmetic. The issue numbers refer to issues I have accumulated in the Gitea repository for my own reference.

Archival Documents page (issue #13)

  • Limit the Document Title column width and wrap long titles. All columns in the table should fit on the screen.
  • Left-align Document Title and Type columns
  • Add Author, Document Date columns to the table

Document Detail page (issue #15)

  • In Create/Edit mode, When linking people by role it is impossible to distinguish between two people with the exact same name (e.g., there are two Albert Edward Higgins, Albert Edward Higgins (father & son). Possible solutions:
    • Consider using the Display Name instead, and adding a contraint that the Display Name be unique
    • Consider concatenating birth year onto the Full Name (e.g., 'Albert Edward Higgins (1885)')
  • In View mode, The person entries in the "Related People" box should be hyper-linked to their People Detail pages
  • Move "View All Sources" box from under image to under Pipeline Jobs. Consider combining both Pipeline Jobs and Sources together in one box.
  • Hide unused fields when not in Edit mode. Example: When editing the Document Detail page there are boxes for Exact Date and Approx. Date. Only one field is ever used (never both). Is it possible to hide the unused field when not in Edit mode?

Archival Entities: People page (issue #19)

  • Left align Display Name, Maiden Name columns
  • Birth Date column should contain Birth Date if known, else Approx Birth Date if known, else "unknown".
  • Add Death Date column with rule similar to Birth Date

Person Detail page (issue #17)

  • Add "New Document" button to People page to accommodate an additional workflow: Add new person --> Add document --> Add job. The current workflow is this: Add new document --> Link person, add new if one doesn't exist --> Add job The user should be able to start from either Document or Person, whichever seems more natural to them.
  • Hide unused fields when not in Edit mode. Example: When editing the People Detail page there are boxes for birth date and approx. birth date. Only one field is ever used (never both). Hide the unused fields on the Person Detail page when not in Edit mode.

Source Asset Records page (issue #12)

  • A Source with a long Document Name or Upload Title forces columns (e.g., Stored Filename, Status, and Error Detail) off the right edge of the bounding box. Limit the width of the columns and wrap their contents. All columns in the table should fit on the screen.
  • Remove Stored Filename from the table
  • Left align Document Name, Upload Title, and Error Detail

Source Detail page (issue #10)

  • If a Source is one page of a multi-page document, add left/right navigation arrows on either side of the displayed image or page (which ever is easier to implement) screen to allow the user to page through the Sources without having to exit select another source then go back into the source detail screen.

Transcription Pipeline Jobs page

  • No changes at this time

Job Detail Page (issue #7)

  • Is it possible to add an automatic screen refresh while waiting for a job to finish? This could happen on a timed basis, like every 3-5 seconds.

Home page

  • Is the current location of the home page in the ./data/homepage folder the correct location to store the image & markdown file? Does it belong somewhere else in the repository like the context prompt which is in ./prompts

New Features

  • Consider creating a "Settings" page. My idea is that this page would provide one place for the user to customize the app. This screen may lead to subscreens. For example, the View/Edit prompt button might call up a page where the markdown is displayed in an editable box, and include a brief description of what the prompt is, how it's used, and the document format (markdown).
    • Maintain Document Types and People Roles
    • View/edit .env?
    • View/edit theme?
    • View/edit prompt?
  • Consider adding field to Person Detail page (and person table) for links to ancestry.com and familysearch.org (and maybe others in the future). Explore using familysearch.org api to automatically populate Person details like Birth date, Birth Place, Death Date, Death Place, etc. (The goal here is not reinvent the wheel and leverage existing data).
  • Consider adding the ability to renumber/reorder pages. (What happens when they get imported out of order?)
  • Consider adding link to location/place fields to Google Maps. (Perhaps this is better left to the genealogy services...)