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

Content deleted Content added
; bot : If specified, a note about automatic archiving will be shown. ; age : If specified, the archiving delay will be provided.
imported>Funandtrvl
छो add more parameters to usage example, copy-edit
लाइन 4:
{{notice|This template is called by [[Template:Archive box]]. Please ensure that any changes do not break the legacy functionality of archive box.}}
 
The <code><nowiki>{{archives}}</nowiki></code> cantemplate may be used to add a box containing page links to 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.
 
It will automatically detect archived pages by default if they are named appropriately; this means that it doesn't need to be manually updated when a new archive is created.
 
=== Usage ===
 
<pre>
{{archives
|archivelist= /archivelist
|auto= <short|long|no>
|index= /Archive index
|search= <yes|no>
|list=
|collapsible= <yes|no>
|collapsed= <yes|no>
|style=
|title=
|image=
|bot=
|age=
}}
</pre>
 
===Parameters===
; archivelist: Specifies a link to a subpage, containingsuch 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 See "Archive list" below. Ifleft unspecified, the default is "long"; any other word (except "no") will result in "short". and "no" disables auto-detection.
; index: Adds an "Index" link toin the box title, to thea specified subpage, whichsuch as "/Archive index" that should be athe subject index topage for all archived discussions. [[User:HBC Archive Indexerbot|HBC Archive Indexerbot]] can automatically generate such indexes.
; auto=<short|long|no>: Specifies the format of the auto-generated archive list. See "Archive list" below. If unspecified, the default is "long"; any other word (except "no") will result in "short". "no" disables auto-detection.
; search: If specified''yes'', the <code>search</code> parameter adds a search box to the template.
; list: Inline list of archives. This is unneedednot 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.
; collapsible : MakesIf ''yes'', makes the list [[Help:Collapsing|collapsible]].
; collapsed : MakesIf ''yes'', makes the list collapsed.
; style : ArbitraryAn arbitrary string of CSS tocan be applied to the box; (use with care).
; title : TheAn bolded archivealternate title, defaults to a bolded "ArchiveArchives".
; image : TheAn archivealternate image to be used, defaults to "<tt><nowiki>[[Image:Replacement filing cabinet.svg|40px|]]</nowiki></tt>".
; 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]].
 
ByIf defaultno (witharchivelist nosubpage explicitis parameters)detected, thenumbered archive listsubpages presentedwill be listed in thelong boxformat. isSuch determinedpages automatically.must be named as "/Archive #" because other naming styles will not be detected. If ano subpagesubpages are found, the archivebox will contain only the "About" and "Edit" links, with the Edit link targeted calledat "<code><nowiki>{{PAGENAME}}</nowiki>/archivelist</code>" exists, itwhich willcan then be used asto thebegin centralmanually content ofpopulating the box (for an examplelist, seeif [[Talk:Evolution]], which draws from [[Talk:Evolution/archivelist]])desired.
 
If the "<code>auto</code>" parameter is explicitly specified, the "Edit" link is removed. The "<code>long</code>" auto format (the default) indicates "Archive 1", "Archive 2", and so on. The "<code>short</code>" auto format indicates only the archive number. See more examples below.
If no archivelist subpage is detected, numbered archive subpages will be listed in long format. Such pages must be named as "/Archive #". Other naming styles will not be detected. If no subpages are found, the archivebox will contain only the "About" and "Edit" links, with the Edit link targeted at "<code><nowiki>{{PAGENAME}}</nowiki>/archivelist</code>" (which can then be used to begin manually populating the list, if desired).
 
If you specify an archive list explicitlyis specified, the name of the subpage is changed, but; otherwise, the behavior is the same.
If the "<code>auto</code>" parameter is explicitly specified, the "Edit" link is removed. The "<code>long</code>" auto format (the default) indicates "Archive 1", "Archive 2", and so on. The "<code>short</code>" auto format indicates only the archive number. See examples below.
 
If you specify an archive list explicitly, the name of the subpage is changed, but otherwise, the behavior is the same.
 
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.)
 
The auto-generated archive list requires subpages to use the common naming convention. That is, "<nowiki>{{PAGENAME}}</nowiki>/Archive 1", "<nowiki>{{PAGENAME}}</nowiki>/Archive 2", and so on. The letter "A" must be capitalized, there must be a single space between the word "Archive" and the number, and there must be no leading zeros. If archive subpages do not conform to this convention, they can be [[Help:Moving a page|renamed]] to conform, or a manual list can be maintained.
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.)
 
The auto-generated archive list requires subpages to use the common naming convention. That is, "<nowiki>{{PAGENAME}}</nowiki>/Archive 1", "<nowiki>{{PAGENAME}}</nowiki>/Archive 2", and so on. The letter "A" must be capitalized, there must be a single space between the word "Archive" and the number, and there must be no leading zeros. If archive subpages do not conform to this convention, they can be [[Help:Moving a page|renamed]] to conform, or a manual list can be maintained.
 
Specifying "<code>auto</code>" with any right-hand-side value other than "<code>long</code>" or "<code>no</code>" results in the short-format list; the use of "<code>short</code>" as the value just makes things more obvious to others.
 
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.
 
=== Examples ===
; Default
 
; Defaults
 
<code><nowiki>{{archives}}</nowiki></code>
Line 66 ⟶ 68:
 
<code><nowiki>{{</nowiki>archives
|auto= short
|index= /Archive index
<nowiki>}}</nowiki></code>
 
Line 77 ⟶ 79:
 
=== See also ===
 
 
* {{lt|{{BASEPAGENAME}}}} <!-- self-listing for quick access on edit history -->
* {{lt|archive box}}