टेम्पलेट:Archives/doc: रिवीजन सभ के बीचा में अंतर

Content deleted Content added
imported>Vadmium
→‎Usage: Indicate unnamed parameter in usage template
imported>Vadmium
Split parameter list into separate sections; put #Archive list sections first
लाइन 7:
The <code>{{tl|{{BASEPAGENAME}}}}</code> template may be used to add a box containing page links to [[Help:Archiving a talk page|archived discussions]]. It will automatically detect archived pages by default if they are named appropriately, eliminating the need to manually update the box each time a new archive page is created.
 
=== Usage ===
<pre>
{{ archives
लाइन 30:
</pre>
 
===Parameters Archive list ===
; archivelist: Specifies a link to a subpage, such as "/archivelist" that contains the archive list. See the "Archive list" and "Additional notes" sections below for further important details.
; auto= <short|long|no>: Specifies the format of the auto-generated archive list. If left unspecified, the default is "long"; any other word (except "no") will result in "short" and "no" disables auto-detection.
; index: Links the "Archives" title to a specified subpage, such as "/Archive index", that should be the subject index page for all archived discussions. [[User:HBC Archive Indexerbot|HBC Archive Indexerbot]] can automatically generate such indexes.
; list: Inline list of archives. This is not needed if the pages are named "Archive 1", "Archive 2" and so on, in which case automatic archiving works, but can be used in addition to automatic archiving if additional pages with other names are available.
; target: The title of the page (just the name, no link syntax) that threads are currently being archived to, for manual archiving.
; collapsible : If ''yes'', makes the list [[Help:Collapsing|collapsible]].
; collapsed : If ''yes'', makes the list collapsed.
; style : An arbitrary string of CSS can be applied to the box (use with care).
; title : An alternative title, defaults to "Archives". The title is automatically linked to the archive index page if one is specified, otherwise a wiki link may be specified here.
 
==== Icon image ====
; image : An alternate image to be used, defaults to "<code><nowiki>Replacement filing cabinet.svg</nowiki></code>".
; link : Link for the image. This normally defaults to empty, which means no link. However, if <code>alt</code> is nonempty, it defaults to the image's file page.
; alt : Alt text for the image, for visually impaired readers. See [[WP:ALT]]. This defaults to empty. If a nonempty value is specified for <code>link</code>, <code>alt</code> should be nonempty too, and should indicate what will happen if the user clicks on the image.
 
The ''link'' and ''alt'' parameters only take effect if the image is changed from the default.
 
==== Search ====
; search: If ''yes'', adds a search box to the template.
; root: Specify a different base than <code>{&#123;FULLPAGENAME}}/</code>. Use '''prefix''' if the additional of a trailing slash is not desired.
;search-break: ''Default'':no
;search-width: ''Default'':22
;search-button-label: ''Default'': Search
 
==== Bot archive notice ====
; bot : If specified, a note about automatic archiving will be shown.
; age : If specified, the archiving delay will be provided.
 
=== Archive list ===
By default (with no explicit parameters), the archive list presented in the box is determined automatically. If a subpage called "<code><nowiki>{{PAGENAME}}</nowiki>/archivelist</code>" exists, it will be used as the central content of the box. For an example, see [[Talk:Evolution]], which draws from [[Talk:Evolution/archivelist]].
 
Line 72 ⟶ 47:
Using "auto=no" will disable archive auto-detection. Manually specified archives will still be shown.
 
==== Additional notes ====
The "<code>auto</code>" and "<code>archivelist</code>" parameters are not intended to be used together. (Doing so removes the edit link, but will still use the specified archive list page if it exists.)
 
Line 80 ⟶ 55:
 
The short and long auto lists are generated by {{tl|archive list}} and {{tl|archive list long}}, respectively. They are limited to a maximum of 100 and 36 subpages, respectively. Beyond those limits, additional subpages will not be listed. In such cases, a manually generated archive list subpage would need to be created and maintained.
 
==== Icon image ====
; image : An alternate image to be used, defaults to "<code><nowiki>Replacement filing cabinet.svg</nowiki></code>".
; link : Link for the image. This normally defaults to empty, which means no link. However, if <code>alt</code> is nonempty, it defaults to the image's file page.
; alt : Alt text for the image, for visually impaired readers. See [[WP:ALT]]. This defaults to empty. If a nonempty value is specified for <code>link</code>, <code>alt</code> should be nonempty too, and should indicate what will happen if the user clicks on the image.
 
The ''link'' and ''alt'' parameters only take effect if the image is changed from the default.
 
==== Search ====
; search: If ''yes'', adds a search box to the template.
; root: Specify a different base than <code>{&#123;FULLPAGENAME}}/</code>. Use '''prefix''' if the additional of a trailing slash is not desired.
;search-break: ''Default'':no
;search-width: ''Default'':22
;search-button-label: ''Default'': Search
 
=== Archival method ===
; target: The title of the page (just the name, no link syntax) that threads are currently being archived to, for manual archiving.
; bot : If specified, a note about automatic archiving will be shown.
; age : If specified, the archiving delay will be provided.
 
=== Other parameters ===
; index: Links the "Archives" title to a specified subpage, such as "/Archive index", that should be the subject index page for all archived discussions. [[User:HBC Archive Indexerbot|HBC Archive Indexerbot]] can automatically generate such indexes.
; collapsible : If ''yes'', makes the list [[Help:Collapsing|collapsible]].
; collapsed : If ''yes'', makes the list collapsed.
; style : An arbitrary string of CSS can be applied to the box (use with care).
; title : An alternative title, defaults to "Archives". The title is automatically linked to the archive index page if one is specified, otherwise a wiki link may be specified here.
 
=== Examples ===
Line 101 ⟶ 102:
{{clear}}
 
=== See also ===
{{Warchivenav}}