Πρότυπο:Documentation

Τεκμηρίωση προτύπου

Αυτό το πρότυπο αυτόματα εμφανίζει ένα κουτί τεκμηρίωσης, του οποίου το περιεχόμενο διασυμπεριλαμβάνεται από μια άλλη σελίδα.Χρησιμοποιείται σε σελίδες που διασυμπεριλαμβάνονται σε άλλες σελίδες δηλαδή πρότυπα ,είται αυτά βρίσκονται στον χώρο ονομάτων 'Πρότυπα' είτε όχι.

Χρήση

Σε όποια σελίδα προτύπου θέλουμε να εμφανιστεί και ένα κουτί τεκμηρίωσης προσθέτουμε το πρότυπο {{Documentation|εναλλακτική σελίδα περιεχομένου|content=τεκμηρίωση}}

Προκαθορισμένη σελιδα /doc

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

<noinclude>{{Documentation}}</noinclude>

Καθορισμός μιας οποιαςδήποτε /doc σελίδας

Στην περίπτωση αυτή η σελίδα /doc μπορεί να βρίσκεται όπουδήποτε. Πχ στον χώρο του χρήστη.

<noinclude>{{Documentation|Πρότυπο:οποιαδήποτε σελίδα/doc}}</noinclude>

Ενσωματώσιμο περιέχομενο

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

<noinclude>{{Documentation|content=Εδώ συμπληρώνουμε την σύντομη τεκμηρίωση μας.}}</noinclude>

Ενσωματώσιμο περιεχόμενο με συνδέσμους [εμφάνιση][επεξεργασία]

<noinclude>{{Documentation
|1=Template:οποιαδήποτε σελίδα/doc
|content={{Template:οποιαδήποτε σελίδα/doc|παράμετροι}}
}}</noinclude>

Σύνηθης και προτεινόμενη χρήση

Η κλήση του προτύπου θα πρέπει να τοποθετείται στο τέλος του κώδικα του προτύπου, χωρίς επιπλέον διαστήμα πριν "<noinclude>" (που θα προκαλούσε επιπλέον διαστήματα στις σελίδες που θα χρησιμοποιηθεί το πρότυπο)e is used).

Προσθέστε κατηγορίες και διαβικιακούς συνδέσμους στη σελίδα τεκμηρίωσης μέσα στις ετικέτες <includeonly> </includeonly> .

Ρυθμίζωντας την εμφάνιση

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

• : αλλάζει την επικεφαλίδα της τεκμηρίωσης .Αν η τιμή είναι κενή τότε η γραμμή της επικεφαλίδας μαζί και ο σύνδεσμος [επεξεργασία] θα χαθούν.

Λειτουργικότητα

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

Λόγοι της δημιουργίας του προτύπου αυτού

• Η χρήση του προτύπου αυτού επιτρέπει τα πρότυπα καθ'αυτά να προστατευθούν όταν είναι αναγκαία, επιτρέποντας ταυτόχρονα οποιονδήποτε να επεξεργαστεί την τεκμηρίωση, τις κατηγορίες και τους διαβικιακούς συνδέσμους.
• Κείμενο που υπάρχει στη σελίδα του προτύπου προστιθεται στο σύνολο του κειμένου το οποίο θα επεξεργαστεί όταν γίνεται χρήση του προτύπου, για το οποίο υπάρχει περιορισμός μεγέθους για λόγους απόδοσης. Τοποθετώντας την τεκμηρίωση σε ξεχωριστή σελίδα μειώνεται το κείμενο που χρησιμοποιείται για τεκμηρίωση σε μια κλήση προτύπου και σε μερικές ετικέτες noinclude. Σκεφτείται το φόρτο σε έναν κεντρικό εξυπηρετητή όταν εκρεμούν δεκάδες χιλιάδες αιτήσεων για χρήση κάποιων προτύπων για να κατανοήσετε το κέρδος στην απόδοση του συστήματος.