Μάθημα 16

Τεκμηρίωση και βοήθεια

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

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

texdoc

Αν έχετε εγκαταστήσει μία διανομή TeX (π.χ. TeX Live ή MiKTeX) και έχετε συμπεριλάβει την τεκμηρίωση κατά την εγκατάσταση, μπορείτε να έχετε πρόσβαση στην τοπικά αποθηκευμένη τεκμηρίωση χρησιμοποιώντας το εργαλείο γραμμής εντολών texdoc. Τρέχοντας:

texdoc < pkg >

θα ανοίξει η τεκμηρίωση του πακέτου <pkg>. Το εργαλείο θα αναζητήσει στη διαθέσιμη τεκμηρίωση και θα ανοίξει αυτό που θεωρεί ότι αντιστοιχεί καλύτερα στον όρο της αναζήτησής σας. Μπορείτε να δείτε όλα τα σχετικά αποτελέσματα που εντοπίζει και να επιλέξετε αυτό που θέλετε χρησιμοποιώντας:

texdoc -l < pkg >

texdoc.org

Πρόκειται για έναν ιστότοπο που λειτουργεί παρόμοια με το εργαλείο texdoc. Μπορείτε να αναζητήσετε στην τεκμηρίωση που έχει διαθέσιμη, όπως θα κάνατε με το texdoc -l και στη συνέχεια να επιλέξετε από τα αποτελέσματα.

CTAN

Το CTAN είναι το Comprehensive TeX Archive Network. Τα περισσότερα πακέτα LaTeX δημοσιεύονται εκεί. Μπορείτε να χρησιμοποιήσετε το εργαλείο αναζήτησης του ιστότοπου για να βρείτε ένα πακέτο και να προσπελάσετε την τεκμηρίωσή του. Συνήθως, τα πακέτα αποθηκεύονται στο ctan.org/pkg/<pkg-name> και μπορείτε εκεί να δείτε το αρχείο README και την τεκμηρίωση των πακέτων που αποθηκεύονται στο CTAN.

Βιβλία για το LaTeX

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

Η ομάδα του LaTeX έχει μια λίστα βιβλίων που έχουν γραφεί κυρίως από μέλη της. Τα πιο αξιοσημείωτα είναι το επίσημο βιβλίο του Lamport και το εκτενές LaTeX Companion 3rd edition.

Άλλα βιβλία που στοχεύουν στη μάθηση του LaTeX είναι τα εξής:

Λήψη βοήθειας

Υπάρχουν διάφορα διαδικτυακά φόρουμ για να κάνετε ερωτήσεις σχετικά με το LaTeX. Ίσως το πιο δημοφιλές σήμερα είναι το TeX - LaTeX StackExchange. Όταν κάνετε μια ερώτηση, είναι καλύτερο να έχετε προετοιμάσει ένα σαφές παράδειγμα: αυτό που είναι γνωστό ως «ελάχιστο λειτουργικό παράδειγμα» (minimal working example, MWE). Αυτό δεν σημαίνει ότι ο κώδικας λειτουργεί (αλλιώς δεν θα ρωτούσατε!), αλλά μάλλον σημαίνει ότι έχετε κάνει το καλύτερο δυνατό ώστε το παράδειγμα να είναι σαφές, αυτοτελές και ελάχιστο. Το τελευταίο σημαίνει ότι έχετε μόνο όσο περιεχόμενο χρειάζεται για να δείξετε το πρόβλημα.

Πώς να δημιουργήσετε ένα ελάχιστο λειτουργικό παράδειγμα (MWE)

Πώς κατασκευάζετε ένα MWE; Συνήθως το πιο εύκολο είναι να ξεκινήσετε από

\documentclass{article}
\usepackage[T1]{fontenc}
\begin{document}
Text
\end{document}

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

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

Αρχείο καταγραφής

Κάτι που είναι καλό να έχετε διαθέσιμο είναι το αρχείο καταγραφής σας. Αυτό δημιουργείται από το LaTeX κάθε φορά που το εκτελείτε και έχει το ίδιο όνομα με το κύριο αρχείο σας, αλλά κατάληξη .log.

Ανάλογα με το περιβάλλον του λειτουργικού συστήματός σας, ίσως χρειαστεί να «εμφανίσετε τις επεκτάσεις» των αρχείων για να καταλάβετε ποιο αρχείο είναι.

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

Ορισμένοι επεξεργαστές LaTeX καθιστούν επίσης δύσκολη την προβολή του πλήρους κειμένου ενός σφάλματος, γεγονός που μπορεί να αποκρύψει σημαντικές λεπτομέρειες.

Αν έχετε πρόβλημα, οι έμπειροι χρήστες του LaTeX θα ζητήσουν συχνά ένα αντίγραφο του αρχείου καταγραφής σας.

Προχωρώντας περισσότερο

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