Dependencies

• Racket(obviously): Racket download page
• "gregor" library: do "raco pkg install gregor" (say yes to dependencies) Documentation for gregor library
• "html-writing" library: do "raco pkg install html-writing" (say yes to dependencies) Documentation for html-writing library
• "csv-reading" library: do "raco pkg install csv-reading" (say yes to dependencies) Documentation for csv-reading library

How to use

• TL;DR: Open a terminal. The program's command should be available through the terminal(type a few characters of the name, and tab two times to see if it comes up). In this case:
  * for the bilingual calendar: csv-to-html --bi -o path/to/output-file path/to/events-csv path/to/locations-csv
  * for the english calendar: csv-to-html --en -o path/to/output-file path/to/events-csv path/to/locations-csv
  * for the french calendar: csv-to-html --fr -o path/to/output-file path/to/events-csv path/to/locations-csv
  If not, find the path to the directory of the program, and do cd path/to/program/folder. There should be an executable launcher in there. In this case:
  * for the bilingual calendar: ./csv-to-html.exe --bi -o path/to/output-file path/to/events-csv path/to/locations-csv
  * for the english calendar: ./csv-to-html.exe --en -o path/to/output-file path/to/events-csv path/to/locations-csv
  * for the french calendar: ./csv-to-html.exe --fr -o path/to/output-file path/to/events-csv path/to/locations-csv
  If there isn't, there should be a source file csv-to-html.rkt. In this case:
  * for the bilingual calendar: racket csv-to-html.rkt --bi -o path/to/output-file path/to/events-csv path/to/locations-csv
  * for the english calendar: racket csv-to-html.rkt --en -o path/to/output-file path/to/events-csv path/to/locations-csv
  * for the french calendar: racket csv-to-html.rkt --fr -o path/to/output-file path/to/events-csv path/to/locations-csv

  • If the one of the files' path begins with a slash ("-"), you must double-quote the path(i.e. "-path/to/file" instead of -path/to/file)
  • The paths can be relative or absolute.
    • Relative: if in folder /Users/wahkeungchan/folder-of-program and the files are in /Users/wahkeungchan/Downloads, the relative paths of the files are ../Downloads/name-of-file. The .. goes back one folder.
    • Absolute: An absolute path begins with the root folder "/". The absolute path to the "Downloads" folder is /Users/wahkeunchan/Downloads. Use command pwd to see the absolute path of the current directory.
    • To navigate folders using terminal, use cd path/to/folder command. To list files and folders in current directory, use ls. To list files and folders of another directory, use ls path/to/folder.
  • The "-o" option specifies the path of the output file. Without that option, the html is printed to the standard output(see below)

• To print to standard output(which you can redirect to a file with > filename or pipe into another program with | programname ...), simply ommit the "-o" flag: csv-to-html path/to/events-csv path/to/locations-csv

• To see all options and help: csv-to-html -h

  • To see and navigate(scroll, search terms) more easily, you can pipe it to another program such as less: csv-to-html -h | less

• To print default values of parameters(including fields names): csv-to-html --print-defaults

• To see debuggin information during the program execution, add the "-v" flag. csv-to-html -v [other options and filesnmaes] The debugging info will be printed on the terminal standard output.