ioniodi / study-guide

Study guide
2 stars 11 forks source link

Αποθετήριο πηγαίων αρχείων για την δυναμική δημιουργία του Οδηγού Σπουδών

Για την δημιουργία του Οδηγού Σπουδών θα χρησιμοποιήσουμε τα εργαλεία pandoc και weasyprint ή/και latex, τα οποία βασίζονται στην γραμμή εντολών και δουλεύουν καλύτερα σε συστήματα τύπου UNIX, π.χ, Linux, BSD, MacOSX. Με αρκετή υπομονή και επιμονή μερικές φορές δουλεύουν και σε Windows WSL.

Ο σκοπός της εργασίας είναι να γίνει συνεργατική επεξεργασία του αρχικού αρχείου και οργάνωση του σε επιμέρους αρχεία, έτσι ώστε να είναι εύκολη η μελλοντική επεξεργασία και ταυτόχρονα η αυτόματη σύνθεση τους στο τελικό αρχείο σε μορφή PDF. Το αρχικό αρχείο δημιουργήθηκε με μετατροπή από αρχείο odt ή/και docx σε md και περιέχει δεδομένα που δεν χρειάζονται ή που χρειάζονται βελτίωση.

Η οργάνωση και επεξεργασία των αρχείων θα γίνει σε συντονισμό με το συγγενικό αποθετήριο κατασκευής ιστοσελίδας, έτσι ώστε στο μέλλον από ένα μόνο σετ πηγαίων αρχείων να παράγεται τόσο η ιστοσελίδα όσο και ο οδηγός σπουδών. Αυτό πρακτικά σημαίνει ότι μόνο αρχεία που δεν υπάρχουν στο αποθετήριο της ιστοσελίδας χρειάζονται εδώ.

Τα εργαλεία που χρησιμοποιούμε καθώς και η ροή εργασίας που ακολουθούμε είναι παρόμοια και μπορεί να εφαρμοστεί σε πολλά σχετικά έργα, όπου απλό οργανωμένο κείμενο μετατρέπεται σε μορφοποιημένη σελιδοποίηση για διαφορετικά μέσα προβολής, π.χ., δημιουργία βιογραφικού, βιβλίου, κα.

Με δεδομένο ότι ο τελικός τυπωμένος οδηγός σπουδών συνήθως περιλαμβάνει και πολλά αρχεία εικόνας πολύ μεγάλης ανάλυσης (π.χ., 600-1200dpi), κρίνεται σκόπιμο να μην αποθηκεύονται αυτά τα αρχεία με το απλό σύστημα git, αλλά να γίνει χρήση του συστήματος git-lfs ή κάποιας παρόμοιας τεχνολογίας σε διαφορετικό αποθετήριο.

Σχετικά έργα και εργαλεία

https://leanpub.com/

https://github.com/electricbookworks/electric-book

https://github.com/evangoer/pandoc-ebook-template

https://github.com/jd/asciidoc-book-toolchain

https://github.com/softcover/softcover

https://github.com/magicbookproject/magicbook

https://pubsweet.org/docs/core/overview.html

https://bookdown.org/home/about/

https://prepostprint.org/doku.php/en/resources