ErwinKomen / RU-passim

0 stars 0 forks source link

Info: check technical #762

Closed ErwinKomen closed 1 month ago

ErwinKomen commented 1 month ago

... reviewen of de technische informatie op de Home page correct is / aangevuld moet worden

ErwinKomen commented 1 month ago

Actions

  1. Home page
    1. This is index.html
    2. Double checked and removed superfluous news items
    3. Added item about the upcoming launch
  2. The About page
    1. This is about.html
    2. The statistics, where do they come from (user-input of manuscripts, for instance)?
      1. This uses the information available in SourceInfo
      2. There is one model that has an FK to SourceInfo, and we could review the existance of the related information: Manuscript.
        1. Check whether all related manuscripts are still there...
      3. When are SourceInfo objects created, and do they always link to a manuscript?
        1. In view ReaderImport, which is the import of a manuscript
        2. In view ReaderEqualGold
        3. In get_hctemplate_copy(), which creates manuscript + sermons based on the SSGs in a collection (code has "Copy of Historical collection"in it)
        4. Manual creation of manuscript (code has "Manually created" in it)]
      4. Okay, just leave as is
    3. Should the reference to www.ru.nl/passim/upload_manu_json be acceptable in the Source url for the external sources?
      1. Well, it is true to what has happened
  3. The Technical page
    1. Minor adjustments
  4. Double check menu items
    1. Tools > visualizations leads to literature listview
ErwinKomen commented 1 month ago

Notes and recommendations

Technical information

The 'technical information' on the home page is very concise. I only tweaked the “news items” there.

About page

The about page still deserves some attention, especially the following items:

  1. Quick reference: should this stay here?
    1. If so: then at least the part about the “main purpose” must be updated
    2. The info about the source code, the link to github, the link to the short guide and manual (pdf) – that's all ok
  2. Bibliography:
    1. maybe that section should be removed completely?
    2. Perhaps it should be replaced by “How to quote” (Currently, via Help > How to quote you will end up on the About page, where you will not see any information about “quoting”)

Technical page

  1. I have updated the technical page here and there (especially the part about Data access, which talks about visualizations).
  2. One dangling issue may be the API access (bottom right of the technical page). Right now this contains the promise: "Accessing data by a different program will be made possible in the near future". Should that stay?

Menu items

Another small point: currently selecting Tools > Visualizations leads to ... the list of used literature. Suggestions:

  1. either remove Tools > Visualizations
  2. or else: let it lead to MyPassim.
shariboodts commented 1 month ago

Thanks for this, response to your comments:

Technical information The 'technical information' on the home page is very concise. I only tweaked the “news items” there. > See powerpoint about Homepage, which provides alternative content

About page The about page still deserves some attention, especially the following items: >Yes, I will rewrite and provide new content

Quick reference: should this stay here? If so: then at least the part about the “main purpose” must be updated The info about the source code, the link to github, the link to the short guide and manual (pdf) – that's all ok Bibliography: maybe that section should be removed completely? Perhaps it should be replaced by “How to quote” (Currently, via Help > How to quote you will end up on the About page, where you will not see any information about “quoting”)

Technical page I have updated the technical page here and there (especially the part about Data access, which talks about visualizations). One dangling issue may be the API access (bottom right of the technical page). Right now this contains the promise: "Accessing data by a different program will be made possible in the near future". Should that stay? >Yes

Menu items Another small point: currently selecting Tools > Visualizations leads to ... the list of used literature. > See powerpoint about Homepage, which provides alternative list Suggestions:

either remove Tools > Visualizations or else: let it lead to MyPassim.

ErwinKomen commented 1 month ago

Okay, all deferred to the powerpoint about the homepage, then.