Μετάβαση στο περιεχόμενο

Πρότυπο:Parameter names example/τεκμηρίωση

Από τη Βικιπαίδεια, την ελεύθερη εγκυκλοπαίδεια

{{Parameter names example}} – ή εναλλακτικά, {{Generic template demo}} – σκοπεύει να βοηθήσει την τεκμηρίωση προτύπου με την παραγωγή μιας γενικής παρουσίας του προτύπου που χρησιμοποιεί τα ονόματα των παραμέτρων ως τιμές αυτών των παραμέτρων.

Ένα παράδειγμα κειμένου βίκι για τη δημιουργία μιας επίδειξης για το {{Infobox}} (στα δεξιά):

{{{title}}}
{{{above}}}
{{{subheader}}}
{{{subheader2}}}
{{{image}}}
{{{caption}}}
{{{header1}}}
{{{label2}}}{{{data2}}}
{{{label3}}}{{{data3}}}
{{{header4}}}
{{{data5}}}
{{{data6}}}
{{{below}}}
{{Parameter names example
|_template=Infobox
|title |above |subheader |subheader2 |image |caption 
|header1 |label2 |data2 |label3 |data3 |header4 
|data5 |data6 |below
}}

Σημειώσεις χρήσης

[επεξεργασία κώδικα]

Όταν το {{Parameter names example}} χρησιμοποιείται σε μια άμεση υποσελίδα του προτύπου-στόχου – π.χ. στη σελίδα /doc του προτύπου προορισμού – η δική της παράμετρος |_template= που προσδιορίζει το πρότυπο στόχο μπορεί να παραλειφθεί. Με άλλα λόγια, ο παραπάνω κώδικας, εάν χρησιμοποιηθεί στο Template:Infobox/page (όπου το page θα μπορούσε να είναι "doc", "testcases" κ.λπ.), θα γίνει:

{{Parameter names example
|title |above |subheader |subheader2 |image |caption 
|header1 |label2 |data2 |label3 |data3 |header4 
|data5 |data6 |below
}}

Μια εξαίρεση σε αυτό είναι η υποσελίδα "sandbox". Εάν η μονάδα καλείται από μια σελίδα που τελειώνει σε "/sandbox", χρησιμοποιεί αυτή τη σελίδα για να δημιουργήσει την έξοδο του προτύπου και όχι τη βασική σελίδα. Για να παρακάμψετε αυτήν τη συμπεριφορά, μπορείτε να καθορίσετε ρητά την παράμετρο |_template=.

Η μορφοποίηση των ονομάτων των παραμέτρων μπορεί να αλλάξει με την παράμετρο |_display=. Από προεπιλογή, τα ονόματα των παραμέτρων εμφανίζονται σε τριπλές αγκύλες (το πρότυπο παραμέτρων, π.χ. {{{name}}}), αλλά εάν το |_display=italics, ή το |_display=italic έχει οριστεί σε αυτό.

Μια προσαρμοσμένη τιμή για μια παράμετρο μπορεί να παρέχεται χρησιμοποιώντας το |[parameter name]=[value] στη θέση του |[parameter name]. Οποιαδήποτε μορφοποίηση για μια τέτοια τιμή - συμπεριλαμβανομένων, για παράδειγμα, των italics – πρέπει να παρέχεται ως μέρος της τιμής (π.χ. |parameter=''value''<br/>). Οι προσαρμοσμένες τιμές δεν μπορούν να χρησιμοποιηθούν για παραμέτρους των οποίων τα ονόματα αρχίζουν με υπογράμμιση ("_").

Δείτε επίσης

[επεξεργασία κώδικα]