Βοήθεια:Οδηγίες προτύπων: Διαφορά μεταξύ των αναθεωρήσεων
Περιεχόμενο που διαγράφηκε Περιεχόμενο που προστέθηκε
Νέα σελίδα: {{υπό κατασκευή}} '''Η σελίδα αυτή είναι ενδεικτική και δεν αποτελεί επίσημη πολιτική του Βικιλεξ... |
μεταφορά υλικού από το Βοήθεια:Πρότυπα/Πώς γίνεται η τεκμηρίωση ενός προτύπου; |
||
Γραμμή 1:
>> <small>[[Βοήθεια:Πρότυπα]]</small><br>
Κάθε πρότυπο χρειάζεται μία σελίδα με οδηγίες ώστε οι χρήστες να γνωρίζουν που και πως θα το χρησιμοποιήσουν.
Στις οδηγίες πρέπει να περιέχονται τουλάχιστον τα:
Στη σελίδα του προτύπου προσθέτουμε στο τέλος του κώδικα το:
:<nowiki><noinclude>{{οδηγίες}}</noinclude></nowiki>
Αυτό θα δημιουργήσει ένα σύνδεσμο προς μία υποσελίδα με το όνομα Πρότυπο:ΤΟΟΝΟΜΑΤΟΥΠΡΟΤΥΠΟΥΜΑΣ/οδηγίες. Κάνοντας «προεπισκόπηση» ή «δημοσίευση», αν η σελίδα υπάρχει θα εμφανίζονται οι οδηγίες που έχουμε επιλέξει να εμφανίζονται (χρησιμοποιώντας κατάλληλα τα: <nowiki><noinclude></noinclude></nowiki> και <nowiki><includeonly></includeonly></nowiki>). Αν δεν υπάρχει θα εμφανίζεται το:
:''Αυτό το πρότυπο χρειάζεται οδηγίες και πιθανόν κατάταξη σε κατηγορίες. Αν γνωρίζετε τη χρήση του και μπορείτε, δημιουργήστε τη σελίδα οδηγιών.''
με κατάλληλη παραπομπή στο «δημιουργήστε τη σελίδα οδηγιών» ώστε κάποιος να δημιουργήσει τη σελίδα.
Αν η σελίδα των οδηγιών δεν υπάρχει, τότε κάνοντας κλικ στο «δημιουργήστε τη σελίδα οδηγιών» θα σας ανοίξει νέα σελίδα με το κατάλληλο όνομα η οποία θα περιέχει ήδη περιεχόμενο που παίρνει από το {{προτ|οδηγίες/πρότυπο}}. Προσθέστε ό,τι χρειάζεται για να γίνουν κατανοητά, σε μελλοντικούς συντάκτες, ο σκοπός και ο τρόπος χρήσης του προτύπου.
== Γενικά ==
Δημιουργούμε υποφάκελο "ΟΝΟΜΑΠΡΟΤΥΠΟΥ/οδηγίες" (υπάγεται στο πρότυπο).
<!-- ΑΚΥΡΟ: δεν έχει χρησιμοποιηθεί
* εντάσσουμε το νέο αυτό άρθρο στην [[:Κατηγορία:Οδηγίες προτύπων]].
*:Για το σκοπό αυτό χρησιμοποιούμε, στο τέλος του προτύπου, το:
*::<nowiki><noinclude>[[Κατηγορία:Οδηγίες προτύπων]]</noinclude></nowiki> :
''Το "noinclude" το βάζουμε ώστε να μην "περνάει" η κατηγορία και στο αναφερόμενο πρότυπο. Καλό είναι να βάζουμε και κλείδα στο τέλος για να μην εμφανίζονται όλα στο Π. Για παράδειγμα στις οδηγίες του προτύπου ονομαΓ βάζουμε:'' <nowiki><noinclude>[[Κατηγορία:Οδηγίες προτύπων|ονομαΓ]]</noinclude></nowiki>
* εκεί αναφέρουμε τις οδηγίες.
-->
* στο πρότυπο αυτό καθεαυτό χρησιμοποιούμε το:
*:<nowiki><noinclude>{{οδηγίες}}</noinclude></nowiki> :''Το "noinclude" το βάζουμε για να μην εμφανίζονται τα στοιχεία των οδηγιών στη σελίδα που θα χρησιμοποιηθεί το πρότυπο.''
Μέσα στις οδηγίες βάζουμε τουλάχιστον 2 ή 3 ενότητες από τις παρακάτω:
::με ένα "άδειο" υπόδειγμα έτοιμο για αντιγραφή (δηλαδή χωρίς τις παραμέτρους, αλλά με τις αντίστοιχες θέσεις για όλες τις παραμέτρους και με έτοιμες τις ονομαστικές ακόμα και αν είναι προαιρετικές).
:<nowiki>=== Παράμετροι===</nowiki>
::με αναλυτική εμφάνιση των παραμέτρων και χαρακτηρισμό τους αν είναι ονομαστικές και αν είναι υποχρεωτικές ή προαιρετικές
:<nowiki>=== Παραδείγματα ===</nowiki>
::Με παραδείγματα αναλυτικά για όλες τις περιπτώσεις που καλό είναι να έχουν ήδη καταγραφεί στο λήμμα ώστε να μπορεί κάποιος να δει και στην πραγματικότητα το πως δουλεύει
<!--
Προαιρετικά προσθέτουμε αν χρειάζεται και ενότητες όπως:
:<nowiki>== Εξαιρέσεις ==</nowiki> (αν δεν πρέπει να χρησιμοποιηθεί κάπου το πρότυπο π.χ. το "κλείδα ταξινόμησης" χρησιμοποιείται μόνο σε ελληνικά λήμματα).
:<nowiki>== Προσοχή ==</nowiki> (αν υπάρχουν περιορισμοί που δεν είναι εμφανείς π.χ. μερικά πρότυπα καλό είναι να μην "καλούνται" απευθείας ή μερικά πρότυπα μπορεί να μην πλήρη ακόμα και η έλλειψη μιας παραμέτρου να "χτυπάει").
:<nowiki>== Βελτιώσεις ==</nowiki> (αν πιστεύουμε ότι κάτι χρειάζεται, που δεν το έχουμε ακόμα φτιάξει, και μπορεί κάποιος άλλος να το φτιάξει).
-->
: <nowiki>== Προβλήματα ==</nowiki>
::όπου καταγράφονται πιθανά προβλήματα ή σκέψεις για βελτιώσεις.
Τέλος, κλείνουμε με τις Κατηγορίες στις οποίες θέλουμε να εμφανιστεί το πρότυπό μας:
<pre>
▲ <nowiki>{{Οδηγίες}}</nowiki>
<includeonly>
<!-- Βάλτε εδώ στο τέλος τις κατηγορίες, ευχαριστώ -->
[[Κατηγορία:]]
</includeonly>
</pre>
| |||