قالب:Transclude selected excerpt/doc
 | هذه صفحة توثيق فرعية لـ قالب:Transclude selected excerpt. تتضمن معلومات الاستعمال، التصنيفات وأي محتوى آخر ليس من محتويات الأصل لصفحة القالب. |
 | Uses Lua: |
Transclude selected excerpt transcludes the lead of an article as an excerpt. It is designed for use in portals. It returns the text of an article up to but excluding the first header, after removing:
- initial templates such as infoboxes, hatnotes and article improvement tags
- noinclude sections
- references and footnotes
- images, unless specifically retained
Usage
{{Transclude selected excerpt | 1= | 2= | selected= | paragraphs= | files= | fileargs= | more= | errors= }}
Parameters
The template accepts any number of page names as unnamed parameters. One of them is selected using the selected= parameter, and the page with that title is transcluded. (If the selected page is invalid, the template will choose again.) Include a namespace where necessary. There are no other positional parameters, but there is one mandatory named parameter:
- An integer representing the parameter number of the selected article, such as
selected=3. Ideally the integer will range from 1 to the number of articles named, but the number will be normalised into that range if necessary. {{Date and time templates}} or time parser functions may be useful, for exampleselected={{#time:n}}to use the month number (1–12).
There are some optional named parameters:
- A list of paragraphs such as
paragraphs=1,3-5; the default is all paragraphs. - A list of file (image) numbers such as
files=1; the default is no images. Non-free images are removed. - Arguments to pass to File: such as
fileargs=leftto move images to the left; the default is none. errors=to allow Lua error messages to appear in the outputshowall=to show all articles simultaneouslylist=to show a list of articles قالب:Warnsign
paragraphs= and files= each accept a comma-separated list containing numbers and/or number ranges in the format min-max. Alternatively, files= can accept the name of a single image, e.g. files=My image file.jpg.
showall= shows all articles simultaneously. This option is intended for a subpage aimed at editors as well as readers. Using this template on a subpage with <noinclude>|showall=</noinclude> and transcluding the subpage on a main page will show all excerpts on the subpage but only one on the main page, without repeating the template and its arguments.
As an alternative, the article names can be given as named parameters. In this case, there will be no unnamed parameters. The desired article is selected using its parameter name. For example, |selected={{#time:Md}}|Jan01=New Year's Day|Jan02=1971 Ibrox disaster|Jan03=... could display an appropriate anniversary, without having to calculate how many days have elapsed in a (possibly leap) year. (#time:Md evaluates to a string representing the current date, e.g. "يوليو04".)
Page options
Each page to be transcluded may be specified either plain or as a wikilink, possibly piped. Links to sections also work, and extract the named section rather than the lead. Examples: Article; Article#Section; [[Article]]; [[Article#Section|A section of an article]]. (Any piped text will be ignored.)
Any of the above formats may be followed by option(s) separated by pipes, e.g. Article|paragraphs=2. Such options override any global options for the given page only. Note that the characters | and = have special meaning within calls to templates but can be escaped using {{!}} and {{=}} respectively. Examples: Article#Section{{!}}files{{=}}2; [[Article|Some page]]{{!}}files{{=}}3,4{{!}}more{{=}}Click here. (= need not be escaped if the parameter is explicitly numbered, e.g. 1=Article{{!}}files=2).
Special characters such as pipes within page options must be doubly escaped, replacing their double braces by {{((}} and {{))}}. For example, to set display Custom image.jpg on the left with a custom caption, set fileargs to left|Custom caption using Article{{!}}files{{=}}Custom image.jpg{{!}}fileargs{{=}}left{{((}}!{{))}}Custom caption. To add a wikilink within a caption, escape the link brackets and any pipe twice using {{!((}}, {{))!}} and possibly {{!}}, e.g. Caption with {{((}}!(({{))}}Pipe (computer science){{((}}!{{))}}piped{{((}}))!{{))}} link. This text can be achieved more simply using {{Doubly escaped wikilink}}, e.g. Caption with {{Doubly escaped wikilink|Pipe (computer science)|piped}} link.
See also
- {{Transclude lead excerpt}}: specifies the article explicitly
- {{Transclude linked excerpt}}: chooses the article randomly from those linked from a page
- {{Transclude list item excerpt}}: chooses the article randomly from those listed on a page
- {{Transclude random excerpt}}: chooses the article randomly from a list
The templates were discussed at Use of direct transclusion in portals and the newer portal transclusion templates.
TemplateData
See the monthly error report for this template.
TemplateData for Transclude selected excerpt
Transclude selected excerpt transcludes the lead of an article chosen from a list as an excerpt
| وسيط | وصف | نوع | حالة | |
|---|---|---|---|---|
| 1 | 1 | The name of a page which may be transcluded
| نص | اختياري |
| 2 | 2 | The name of another page which may be transcluded. Similarly for optional parameters 3, 4, ...
| نص | اختياري |
| Selected | selected | Number of the article to be transcluded
| رقم | مطلوب |
| Paragraphs | paragraphs | Numbers of the paragraphs to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max
| نص | اختياري |
| Files | files | Numbers of the images to be transcluded, as a comma-separated list containing numbers and/or number ranges in the format min-max
| نص | اختياري |
| FileArgs | fileargs | Arguments to pass to File:
| نص | اختياري |
| More | more | Text for trailing link to the entire article. Note: more=no suppresses the link.
| نص | اختياري |
| Errors | errors | Allow Lua error messages to appear in the output?
| بولياني | اختياري |
| ShowAll | showall | Show all excerpts simultaneously?
| نص | اختياري |
| List | list | Show a list of excerpts?
| نص | اختياري |