Δημιουργία εγγράφων

Η δευτερεύουσα χρήση του configlet είναι η δημιουργία εγγράφων.

Χρήση

Η εντολή generate μπορεί να χρησιμοποιηθεί για τη δημιουργία εγγράφων οδηγιών/εισαγωγής από ένα πρότυπο.

configlet [global-options] generate

Global options:
  -h, --help                   Show this help message and exit
      --version                Show this tool's version information and exit
  -t, --track-dir <dir>        Specify a track directory to use instead of the current directory
  -v, --verbosity <verbosity>  The verbosity of output. Allowed values: q[uiet], n[ormal], d[etailed]

Έγγραφα

Αυτά είναι τα έγγραφα που μπορεί να δημιουργήσει το configlet.

Έγγραφο: Το αρχείο introduction.md μιας Άσκησης Έννοιας

Κάθε Άσκηση Έννοιας έχει ένα αρχείο introduction.md. Κάθε άσκηση μπορεί να έχει ένα προαιρετικό αρχείο introduction.md.tpl.

Το αρχείο προτύπου πρέπει να αντιμετωπίζεται όπως ένα συνηθισμένο αρχείο Markdown, με μία μόνο προσθήκη: τη δυνατότητα να ορίζεις placeholders. Υποστηρίζονται οι εξής placeholders:

• %{concept:<slug>}: παραπέμπει στο έγγραφο introduction.md της έννοιας

Όταν το configlet εντοπίσει ότι μια Άσκηση Έννοιας έχει αρχείο introduction.md.tpl, θα δημιουργήσει από αυτό ένα αρχείο introduction.md. Η εισαγωγή που δημιουργείται θα έχει το ίδιο περιεχόμενο με το πρότυπο, εκτός από τους placeholders, οι οποίοι θα αντικατασταθούν με το περιεχόμενο των εγγράφων στα οποία παραπέμπουν.

Έγγραφο: Το αρχείο introduction.md μιας Άσκησης Εξάσκησης

Όταν το configlet εντοπίσει ότι μια Άσκηση Εξάσκησης υλοποιεί μια Άσκηση του Problem Specifications που έχει αρχείο introduction.md, το configlet θα συγχρονίσει το αρχείο .meta/introduction.md της Άσκησης Εξάσκησης με το αρχείο introduction.md της Άσκησης του Problem Specifications.

Έγγραφο: Το αρχείο instructions.md μιας Άσκησης Εξάσκησης

Όταν το configlet εντοπίσει ότι μια Άσκηση Εξάσκησης υλοποιεί μια Άσκηση του Problem Specifications, το configlet θα συγχρονίσει το αρχείο .meta/instructions.md της Άσκησης Εξάσκησης είτε με το αρχείο instructions.md της Άσκησης του Problem Specifications είτε με το αρχείο description.md της, όταν δεν βρεθεί αρχείο instructions.md.

Έγγραφο: Το αρχείο .meta/config.json μιας Άσκησης Εξάσκησης

Όταν το configlet εντοπίσει ότι μια Άσκηση Εξάσκησης υλοποιεί μια Άσκηση του Problem Specifications, το configlet θα συγχρονίσει τα κλειδιά source και source_url της Άσκησης του Problem Specifications από το αρχείο metadata.yml της με τις ιδιότητες source και source_url της Άσκησης Εξάσκησης στο αρχείο .meta/config.json της.