Skip to content
This repository has been archived by the owner on Jun 25, 2020. It is now read-only.

Μετατροπή δομής για τη βιβλιογραφία των μαθημάτων σε bibtex #119

Merged
merged 3 commits into from
May 7, 2020

Conversation

p15zerv
Copy link
Collaborator

@p15zerv p15zerv commented May 3, 2020

Σχετικό Issue

closes #96

Demo, μιας και το preview δε θα λειτουργεί σωστά λόγω εξάρτησης με το PR στο theme.

Προτεινόμενες Αλλαγές

-- Προσθήκη jekyll-scholar και μετατροπή βιβλιογραφίας σε bibtex.
-- Το bibtex περιέχει περαιτέρω πληροφορίες, όπως εξώφυλλο και περιγραφή (όπου αυτή υπήρχε), που έχουν ανακτηθεί από τον Εύδοξο.
-- Για κάθε βιβλίο δημιουργείται σελίδα για την εμφάνισή του μέσω του jekyll-scholar, η οποία είναι της μορφής /bibliography/isbn_xxxx.

Σχόλια και Παρατηρήσεις

-- Θα πρέπει μάλλον πρώτα να γίνει δεκτό το αίτημα στο theme #24.
-- Η προσθήκη του jekyll-scholar έχει οδηγήσει σε μία μέτρια καθυστέρηση στο build του site. Τοπικά, είναι της τάξης των 20-30 δευτερολέπτων συνολικά το build μας.
-- Το αρχείο _layouts/bibtex.html σε όσες δοκιμές έκανα τοπικά δε φαίνεται να μπορεί να τοποθετηθεί απομακρυσμένα στο theme. Το jekyll-scholar βγάζει errors/warnings ότι δε βρίσκει το αρχείο, οπότε ίσως διαχειρίζεται διαφορετικά τα αρχεία. Επομένως για τώρα, αν και γνωρίζω ότι δεν είναι η καλύτερη πρακτική, συμπεριλαμβάνεται κι εδώ το _layouts/bibtex.html, το οποίο παρουσιάζει το πρόβλημα.
-- Καθώς έχει αναφερθεί αρκετές φορές, θα χρειαστεί σίγουρα τεκμηρίωση για το πως συνεχίζουμε στο μέλλον με το bibtex καθώς και να δωθούν εναλλακτικές σε περίπτωση που αποδειχτεί ότι αυτό δε βολεύει. Αυτό θεωρώ είναι μάλλον καλύτερο να γίνει στη συνέχεια, στο στάδιο τεκμηρίωσης, όπου θα συμπεριληφθεί το json αρχείο με όλη την πληροφορία του bibtex και ενδεικτικός κώδικας για μετατροπή από bibtex σε yaml.

Υπενθυμίσεις

  • Έχω ανοίξει από πριν issue για τον καλό συντονισμό του project, το οποίο έχει πάρει το πράσινο φως με την αντίστοιχη ετικέτα
  • Έχω δημιουργήσει branch για τις αλλαγές

@p15zerv
Copy link
Collaborator Author

p15zerv commented May 3, 2020

Αφήνω κι εδώ ενδεικτικά reviewers, είναι πολλά τα αρχεία κι οι αλλαγές, οπότε έβαλα όποιους θεωρώ καταλληλότερους (sorry @constantinexisc) και τον @epidrome, μιας κι έχει δείξει αρκετό ενδιαφέρον καθόλη την πορεία. Όποιος δε θέλει να συμμετάσχει, ας αφαιρέσει τον εαυτό του και ας βάλει ίσως άλλον στην θέση του.

Για να βοηθήσω κιόλας όσο μπορώ, οι αλλαγές στα αρχεία των courses είναι αρκετά repetitive και απλώς συμπεριλαμβάνεται το αντίστοιχο bibtex key. Αν κρίνετε πως είναι οκ για 2-3, το ίδιο μάλλον θα ισχύει και για τα υπόλοιπα, μιας και η διαδικασία ήταν αυτοματοποιημένη.

Από εκεί και πέρα, στο config έχουν περαστεί οι απαραίτητες ρυθμίσεις για να δημιουργείται η σελίδα details για κάθε βιβλίο. Σχετικό link στο documentation του jekyll-scholar: https://github.com/inukshuk/jekyll-scholar#detail-pages

Copy link
Collaborator

@dimpram dimpram left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ειλικρινά συγχαρητήρια για τον κόπο σου για την μετατροπή όλων των βιβλίων με αυτόν τρόπο αλλά και για την κομψή υλοποίση σου που την κάνω review και στο minimal-ionio παρόλο που δεν είμαι reviewer. Μου κίνησε το ενδιαφέρον! Θεωρώ πως είναι ένα πάρα πολύ σημαντικό contribution για το site.

Το γεγονός οτι αυξήθηκε το build time ήταν αναμενόμενο και όταν εντέλει το site πλησιάσει το production θα έχει αυξηθεί ακόμα περισσότερο. Εως τότε όμως ενδεχομένως να έχουμε βρει άλλους τρόπους να το κάνουμε minimize με την βοήθεια άλλων εργαλείων.

Όσο αφορά το layout είμαι σίγουρος οτι υπάρχει τρόπος να το μετακινήσουμε αποκλειστικά στο remote_theme οπότε δεν νομίζω να είναι πρόβλημα. Ενδεχομένως να λυθεί με αφορμή το #106

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Εγώ είμαι reviewer σε αυτό το PR αλλά όχι στο παράλληλο PR του minimal-ionio? Θα μπώ και εγώ όπως ο @JimDragon εκεί μιας και τις αλλαγές πρέπει να τις δούμε και στα 2 αποθετήρια μαζί.

ΠΡΟΣΟΧΗ όποιος είναι να το κάνει merge (να μπέι κάποιος assignee) να ελέγξει ότι έχει κλείσει το παράλληλο ioniodi/minimal-ionio#24

@p15zerv
Copy link
Collaborator Author

p15zerv commented May 3, 2020

Εγώ είμαι reviewer σε αυτό το PR αλλά όχι στο παράλληλο PR του minimal-ionio? Θα μπώ και εγώ όπως ο @JimDragon εκεί μιας και τις αλλαγές πρέπει να τις δούμε και στα 2 αποθετήρια μαζί.

ΠΡΟΣΟΧΗ όποιος είναι να το κάνει merge (να μπέι κάποιος assignee) να ελέγξει ότι έχει κλείσει το παράλληλο ioniodi/minimal-ionio#24

Κυρίως διότι δεν ήθελα να σας φορτώσω παραπάνω, αλλά ακόμη καλύτερο το να αφήσετε άποψη και στα δύο!

@ghost
Copy link

ghost commented May 3, 2020

@p15zerv Κάνε και κάποιον assignee στο να κάνει merge και τα 2, να είναι ο ίδιος.

@korinaal
Copy link
Collaborator

korinaal commented May 5, 2020

Μου φαίνονται όλα ΟΚ, Έχω αφήσει και σχετικό review στο theme. Αναμένω μια-δυό μέρες για περαιτέρω σχόλια (αν υπάρξουν), προτού προχωρήσω σε merge.

@epidrome
Copy link
Member

epidrome commented May 6, 2020

-- Το αρχείο _layouts/bibtex.html σε όσες δοκιμές έκανα τοπικά δε φαίνεται να μπορεί να τοποθετηθεί απομακρυσμένα στο theme.

το τζεκιλ σκόλαρ ειναι ένα είδος πλαγκιν, υπάρχουν πολλά είδη πλαγκιν, τα οποία ίσως έχουν περιορισμούς, κάπου εδώ βρίσκεται η απαντήση:
https://jekyllrb.com/docs/plugins/

πάντως το πρόβλημα ίσως να λυθεί έμμεσα αν αλλάξουμε την αρχιτεκτονική #120

@korinaal korinaal merged commit 0d10e8c into ioniodi:master May 7, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Μετατροπή δομής για τη βιβλιογραφία των μαθημάτων σε bibtex
4 participants