Βοήθεια:Οδηγίες προτύπων

Από Βικιλεξικό
Πήδηση στην πλοήγηση Πήδηση στην αναζήτηση

>> Βοήθεια:Πρότυπα
Κάθε πρότυπο χρειάζεται μία σελίδα με οδηγίες ώστε οι χρήστες να γνωρίζουν που και πως θα το χρησιμοποιήσουν.

Στις οδηγίες πρέπει να περιέχονται τουλάχιστον τα:

  • αν χρειάζεται παραμέτρους και ποιες είναι αυτές
  • πού χρησιμεύει

Στη σελίδα του προτύπου προσθέτουμε στο τέλος του κώδικα το:

<noinclude>{{οδηγίες}}</noinclude>

Αυτό θα δημιουργήσει ένα σύνδεσμο προς μία υποσελίδα με το όνομα Πρότυπο:ΤΟΟΝΟΜΑΤΟΥΠΡΟΤΥΠΟΥΜΑΣ/οδηγίες. Κάνοντας «προεπισκόπηση» ή «δημοσίευση», αν η σελίδα υπάρχει θα εμφανίζονται οι οδηγίες που έχουμε επιλέξει να εμφανίζονται (χρησιμοποιώντας κατάλληλα τα: <noinclude></noinclude> και <includeonly></includeonly>). Αν δεν υπάρχει θα εμφανίζεται το:

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

με κατάλληλη παραπομπή στο «δημιουργήστε τη σελίδα οδηγιών» ώστε κάποιος να δημιουργήσει τη σελίδα.

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

Γενικά[επεξεργασία]

Δημιουργούμε υποφάκελο "ΟΝΟΜΑΠΡΟΤΥΠΟΥ/οδηγίες" (υπάγεται στο πρότυπο).

  • στο πρότυπο αυτό καθεαυτό χρησιμοποιούμε το:
    <noinclude>{{οδηγίες}}</noinclude> :Το "noinclude" το βάζουμε για να μην εμφανίζονται τα στοιχεία των οδηγιών στη σελίδα που θα χρησιμοποιηθεί το πρότυπο.

Μέσα στις οδηγίες βάζουμε τουλάχιστον 2 ή 3 ενότητες από τις παρακάτω:

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

Τέλος, κλείνουμε με τις Κατηγορίες στις οποίες θέλουμε να εμφανιστεί το πρότυπό μας:

<includeonly>
<!-- Βάλτε εδώ στο τέλος τις κατηγορίες, ευχαριστώ -->
[[Κατηγορία:]]
</includeonly>