To Do, Programming side

ENCAB

List of things still to do in EnCAB Program:

---

High Priority:

Medium Priority:

• USE GitHub Actions CI/CD to make running EnCAB possible from within GitHub website. There should be two triggers: 1) a commit to Master branch should run the program and put result in the Master branch 2) a commit to develop branch should run the program and put result in the develop branch

• Bibliography reference should link to the first letter of the first author's last name.

Low Priority:

• add JSON as input possibility (for files with .json extension) Il formato JSON è necessario? Secondo me renderebbe solo più complicato l'input. In generale è meglio usare un solo formato, al massimo si potrebbe convertire tutti i file XML in JSON.

• Create BibTex entry for each algorithm, link on algorithm, also make one with all algorithms and (perhaps) all bibliography Bibtex: quale formato? Solitamente viene usato per le bibliografie, non saprei che formato usare per gli algoritmi. In ogni caso penso si crea un unico file contenenti tutti i bibtex (come qui: https://www.lri.fr/~filliatr/bibtex2html/doc/examples/biblio-these_bib.html#Abrial96 ) e si aggiunge [bib] dopo il nome della bibliografia / algoritmo rimandante alla voce nel file.

• Add counter for author contributions / and another counter for modifications. Generate a list for each author with all contributions followed by all modifications. Il numero di contributi e modifiche dove andrebbe inserito? E la lista completa?

Completed:

• favicon.ico

• Comment code extensively so easily followed by a new programmer or can be used in teaching

• ZIP filenames for archival files should also have _HHMMSS (HourMinSec of creation time) at end of filename, so ZIP files are not overwritten

• Add date/time for build at bottom of the 4 algorithm pages (Algorithms sorted by: Bibliography, Material, Step in Process, Type of Algorithm) {{ dateFormat "02 Jan 06 15:04 MST" .Date.UTC }}

• Within each algorithm, "Source info:" and "Also cited in:" should have hyperlinks to bibliography.
  EXAMPLE: Source info: Robson 1999, 67-69 Also cited in: Heimpel 2009, 67-69 "Robson 1999" should be hyperlinked to #RobsonE in the bibliography, and Heimpel 2009 should link to #HeimpelW.
  Note that sometimes there are 2 authors (so Robson and Heimpel 2050, 99-999 should hyperlink to RobsonE_HeimpelW)
  Note2 that sometimes there are 3 or more authors (so Robson, Heimpel and Buccellati 2050, 99-999 should link to #RobsonE_etal)

• In the algorithms, the "Created by/on:" and "Modified by/on:" link to the incorrect HTML page. They should not link to the bibliography, but to the author pages.
  EXAMPLE: "Created by/on: Buccellati F., 30.02.2018" The Buccellati F. now links to the bibliography page, but should instead open the "BuccellatiF.html" page under authors.

• Also, for "Created by/on:" and "Modified by/on:" they should both accept more than one author, listing them one after the other and giving a hyperlink to each author as above.