Πρότυπο:Documentation
Τεκμηρίωση προτύπου[προβολή] [επεξεργασία] [ιστορικό] [ανανέωση]Το πρότυπο {documentation} χρησιμοποιείται για να περιέχει τις τεκμηριωμένες πληροφορίες και οδηγίες ενός συγκεκριμένου προτύπου, συνήθως από μια υποσελίδα /τεκμηρίωση ή /doc. Μπορεί επίσης να ρυθμιστεί ώστε να φορτώνει το περιεχόμενο από άλλες σελίδες ή να τροφοδοτείται απευθείας από κείμενο.
Αυτό το πρότυπο έχει δύο μέρη: το μεγάλο «πλαίσιο τεκμηρίωσης» με την τεκμηρίωση μέσα δίπλα σε μια γραμμή εργαλείων (οι σύνδεσμοι [προβολή] [επεξεργασία] [ιστορικό] [ανανέωση]) και το μικρότερο «πλαίσιο συνδέσμων» που εμφανίζει μεταδεδομένα σχετικά με την τεκμηρίωση μαζί με τους συνδέσμους του πρόχειρου και των δοκιμαστικών περιπτώσεων.
Η χρήση αυτού του προτύπου επιτρέπει την προστασία των προτύπων, όπου είναι απαραίτητο, ενώ επιτρέπει σε οποιονδήποτε να επεξεργαστεί την τεκμηρίωση και τις κατηγορίες.
Γενική σύνταξη
Κανονικά, το πρότυπο χρησιμοποιείται χωρίς παραμέτρους και τοποθετείται μέσα <noinclude>...</noinclude> στο κάτω μέρος της σελίδας του προτύπου (δείτε #Τοποθέτηση και ετικέτες για περισσότερες πληροφορίες):
<!--Τελευταία γραμμή του κώδικα του προτύπου σας--><noinclude>
{Documentation}
<!-- Προσθήκη κατηγοριών στην υποσελίδα /τεκμηρίωση -->
</noinclude>
Συμπερίληψη διαφορετικής σελίδας
Για να ενσωματώσετε μια διαφορετική σελίδα εκτός από την υποσελίδα /doc, απλώς δώστε |1= ως εξής:
<!--Τελευταία γραμμή του κώδικα του προτύπου σας-->
{Documentation|Πρότυπο:Άλλη σελίδα/τεκμηρίωση}
</noinclude>
Σημειώστε ότι κατά τη φόρτωση της τεκμηρίωσης από μια σελίδα διαφορετική από την τοπική υποσελίδα /τεκμηρίωση, είναι δύσκολο να χειριστείτε τις κατηγορίες.
Χρησιμοποιώντας την παράμετρο |content=
Η τεκμηρίωση μπορεί επίσης να τροφοδοτηθεί απευθείας ως κείμενο, χρησιμοποιώντας την παράμετρο |content=:
<!--Τελευταία γραμμή του κώδικα του προτύπου σας-->
{Documentation
| content =
<!-- τεκμηρίωση προτύπου -->
}</noinclude>
Όταν χρησιμοποιείτε αυτήν την παράμετρο, η γραμμή εργαλείων δεν θα εμφανίζεται. Σημειώστε ότι η υποσελίδα /τεκμηρίωση στο πλαίσιο συνδέσμου θα εξακολουθεί να εμφανίζεται εάν υπάρχει.
Σημειώστε επίσης ότι όταν ορίζονται |1= και |content=, έχει προτεραιότητα το |content= και εμφανίζεται πάντα στο πλαίσιο τεκμηρίωσης.
Τοποθέτηση και ετικέτες
Αυτός ο κώδικας θα πρέπει να προστεθεί στο κάτω μέρος της σελίδας κώδικα του προτύπου, χωρίς κενό πριν το </syntaxhighlight>
Κατηγορίες και interwiki
Ανάλογα με το πού τοποθετείται η τεκμηρίωση, μπορεί να είναι δύσκολο να χειριστείτε τις κατηγορίες και τα interwiki. Δείτε Βικιπαίδεια:Τεκμηρίωση προτύπου#Κατηγορίες και σύνδεσμοι interwiki για πληροφορίες σχετικά με την προσθήκη αυτών.
Πλήρης σύνταξη
{Documentation}
ή
{Documentation
| [διαδρομή προς την σελίδα τεκμηρίωσης]
}
{Documentation
| content =
}
ή
{Documentation
| [διαδρομή προς την σελίδα τεκμηρίωσης]
| heading-style =
| heading =
| link box =
}
ή
{Documentation
| [διαδρομή προς την σελίδα τεκμηρίωσης]
| content =
| heading-style =
| heading =
| link box =
| page =
}
Δείτε επίσης
- {Υποσελίδα τεκμηρίωσης}, μια ειδοποίηση που τοποθετείται στην κορυφή μιας υποσελίδας /τεκμηρίωση που εξηγεί τον ρόλο της και περιλαμβάνει έναν σύνδεσμο προς τη σελίδα που τεκμηριώνει.
- Βικιπαίδεια:Τεκμηρίωση προτύπου είναι ένας οδηγός για την τεκμηρίωση προτύπων.