Doclint Documentation Project Utility

Όνομα: Μανώλης Κιαγιάς, gro.DSBeerF|silonam#gro.DSBeerF|silonam
Project: Doclint, Documentation Project Utility, http://www.freebsdgr.org, http://mercurial.freebsdgr.org/mercurial/freebsd-scripts
Γλώσσα: Python
Στόχος: Βελτίωση / Επέκταση doclint utility
Άτομα: 2-3
Βαθμός Δυσκολίας: Μέτριος

Περιγραφή

To doclint.py είναι ένα … python (τι πρωτότυπο) script το οποίο ελέγχει διάφορες παραμέτρους που έχουν να κάνουν κυρίως με style, formatting και whitespace checks στα sgml αρχεία του FreeBSD Documentation Project. Τη δεδομένη στιγμή είναι ένα μάλλον γρήγορο hack το οποίο έγραψα σε λίγες μέρες και το χρησιμοποιώ για να ελέγξω και να διορθώσω προβλήματα αυτού του τύπου σε αρχεία που πρόκειται να γίνουν commit. Γνωρίζω ότι το χρησιμοποιούν και άλλοι documentation committers παρά τις ελλείψεις του.

Ένα παράδειγμα εκτέλεσης φαίνεται παρακάτω:

Παίρνοντας ένα SGML/Docbook αρχείο όπως το παρακάτω:

<para>
      <figure id="vinum-concat">
        <title>Οργάνωση Συνένωσης</title>
        <graphic fileref="vinum/vinum-concat">
      </figure>
    </para>

    <indexterm>
      <primary>disk striping</primary>
    </indexterm>
    <indexterm>
      <primary>Vinum</primary>
      <secondary>striping</secondary>
    </indexterm>
    <indexterm>
      <primary>RAID</primary>
    </indexterm>

    <para>Ένας εναλλακτικός τρόπος αποθήκευσης, είναι να χωριστεί η περιοχή
      διευθύνσεων σε μικρότερα τμήματα ίσου μεγέθους τα οποία να αποθηκεύονται
      σειριακά σε διαφορετικές συσκευές.  Για παράδειγμα, οι πρώτοι 256 τομείς

και εκτελώντας:

doclint.py -a -l78 chapter.sgml

θα είχαμε το εξής αποτέλεσμα:

doclint running...

Line            Result
================================================================================
217:    SPACING:'Array of Inexpensive Disks</emphasis> @και παρέχει διάφορες μορφές'
233:    TAB characters required at start-of-line indentation
439:    TAB characters required at start-of-line indentation
447:    SPACING:'πολύπλοκος κώδικας και περιορισμοί στους υποδίσκους: @πρέπει όλοι'
466:    SPC and TAB characters intermixed at start-of-line indentation
467:    SPC and TAB characters intermixed at start-of-line indentation
468:    SPC and TAB characters intermixed at start-of-line indentation
469:    SPC and TAB characters intermixed at start-of-line indentation
509:    contains unprintable characters only

Αν και το utility γενικά λειτουργεί και είναι χρήσιμο, υπάρχουν ακόμα πολλά που θα μπορούσαν να γίνουν για να βελτιωθεί σαν κώδικας αλλά και να προστεθούν έλεγχοι που λείπουν, π.χ. έλεγχος indentation ανάλογα με το section level.
Το εγχείρημα δεν είναι ιδιαίτερα δύσκολο, και δεν απαιτεί να ξέρετε λεπτομέρειες για SGML, Docbook ή FreeBSD Documentation. Το πρόγραμμα θα δοκιμάζεται στον υπολογιστή του καθενός και στο FreeBSDgr.org αν χρειάζεται.

Δεν απαιτείται να έχετε εγκατεστημένο FreeBSD.

Τα sources θα τηρούνται σε mercurial repository. Μια σχετική γνώση λειτουργίας είναι καλή, αλλά όχι απαραίτητη.

Δηλώσεις Συμμετοχής

Ενδιαφερόμενος email Ημέρες Τομέας Ενασχόλησης
Μπλα μπλα moc.liamg|alpm#moc.liamg|alpm Όλες ---

Αποτελέσματα

To Project δεν πραγματοποιήθηκε λόγω έλλειψης συμμετοχών

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License