| Revision as of 23:27, 27 April 2016 editPppery (talk | contribs)Interface administrators, Administrators100,525 edits Undid revision 716827959 by ClueBot III (talk)← Previous edit |
Revision as of 23:39, 28 April 2016 edit undoClueBot III (talk | contribs)Bots1,377,354 editsm Archiving 3 discussions to User:ClueBot III/Documentation/Archives/. (BOT)Next edit → |
| Line 3: |
Line 3: |
|
|
|
|
|
{{Warning|1=Cluebot III is currently underperforming when confronted with large collections of archive pages for the same talk page (around 200 archive pages for the same talk page seems to be a maximum that should not be exceeded). The issue is discussed at ]. Please don't remove this warning before all related issues are resolved. --] (]) 11:02, 27 January 2016 (UTC)}} |
|
{{Warning|1=Cluebot III is currently underperforming when confronted with large collections of archive pages for the same talk page (around 200 archive pages for the same talk page seems to be a maximum that should not be exceeded). The issue is discussed at ]. Please don't remove this warning before all related issues are resolved. --] (]) 11:02, 27 January 2016 (UTC)}} |
|
|
|
|
==How your page is archived== |
|
|
# ClueBot III can be used to automatically archive sections/threads from a given page. Usually the page you are archiving from will be a talk page. Your archive pages can be numbered, or organized by date. Combinations of dates and numbering are also possible. This is configured by the arguments used for the ''']''' and ''']''' parameters. Please see the ] and ] for a few of the many ways to do this. |
|
|
#: |
|
|
# Archiving by date doesn't means storing according to the last date of each section, but <span style="color:red;">'''storing according to the archiving decision'''.</span> Better use {{User:MiszaBot/Archive HowTo}} if you want to segment a talk page according to the dates of the threads. |
|
|
#: |
|
|
# Archive boxes. ClueBot III gives you two methods for configuring an archive box. You can set <code>archivebox=yes</code> and use the cosmetic parameters to configure the archive box provided by {{tlu|User:ClueBot III/ArchiveThis}}. Or you can set <code>archivebox=yes|index=true</code>. Then template {{tlu|User:ClueBot III/ArchiveThis}} will result into the ] a ClueBot III generated list of archive pages (that can be used inside an {{tl|archivebox}} template. This is useful when archiving is organized by date rather than only by number. When using the standard archiving by number, the various ] can be configured to automatically detect the archive pages. For more information, see the ''']''' and ''']''' parameters. |
|
|
#: |
|
|
# Keeping linked, i.e. updating the links to the archived threads. Once a series of threads is archived, ClueBot III looks for all pages that could have been linked to the moved parts, and updates the links that need to be fixed. <span style="color:red;"> '''When a page is linked to a huge number of others pages, the process takes a lot of time'''</span>. In fact, only the links to an internal anchor of the page should be checked. In any case, this is the reason of collapse described at ]. <span style="color:red;"> '''Said more clearly: don't use ClueBot III on a page where the ''what links here'' are large'''</span>. |
|
|
#: |
|
|
# In addition to archiving your page, ClueBot III can also generate an index of all your archive pages. Assuming that you are archiving the page <tt>Talk:YourPage</tt>, the archive index generated by Cluebot III is located at:<br /> <tt>User:ClueBot III/Master Detailed Indices/Talk:YourPage</tt><br /> You can make use of this either directly or by transcluding it onto your <tt>Talk:YourPage/Archive index</tt> page. One way to use this directly would be to include it as the archive index page in your archive box. For example:<br /> <code><nowiki>{{Archives |auto= short |index= User:ClueBot III/Master Detailed Indices/{{FULLPAGENAME}} |search= yes |bot= ClueBot III |age= 90}}</nowiki></code><br /> will produce an archive box with an appropriate link to your index. If you want to use this index with the {{tl|talk header}} template you will need to transclude it onto your <tt>Talk:YourPage/Archive index</tt> page. To do so you would put the text:<br /> <code><nowiki>{{User:ClueBot III/Master Detailed Indices/{{NAMESPACE}}:{{BASEPAGENAME}}}}</nowiki></code><br /> on your </tt>Talk:YourPage/Archive index</tt> page. |
|
|
|
|
|
==General template format== |
|
|
The general format for the archive template: |
|
|
|
|
|
<pre> |
|
|
<nowiki>{{User:ClueBot III/ArchiveThis |
|
|
|archiveprefix= |
|
|
|format= |
|
|
|age= |
|
|
}}</nowiki> |
|
|
</pre> |
|
|
|
|
|
|
|
|
===Required parameters=== |
|
|
{{anchor|age}}'''age'''<br /> |
|
|
''Type'': unsigned integer<br /> |
|
|
''Default'': 0<br /> |
|
|
''Description'': This parameter must be set to the number '''of hours''' a thread can go without a reply before it should be archived. If you do not set it '''all''' threads will qualify to be archived. |
|
|
|
|
|
|
|
|
{{anchor|archiveprefix}}'''archiveprefix'''<br /> |
|
|
''Type'': string<br /> |
|
|
''Default'': "<nowiki>{{</nowiki>]<nowiki>}}</nowiki>/Archives/" <br /> |
|
|
''Description'': This parameter must be set to a fully qualified page name under the page you wish to archive. For example, if <tt>User talk:Cobi</tt> was being archived using dated archives, then <code>archiveprefix=User talk:Cobi/Archives/</code> would be used. For the same page being archived with numbered archives, <code>archiveprefix=User talk:Cobi/Archive</code> would be appropriate. If you do not set this argument, or if you set it to something invalid, then the default value will be used. However, not setting this parameter correctly can have some strange results. The <nowiki>{{</nowiki>]<nowiki>}}</nowiki> variable can not actually be passed to ClueBot III. The fully qualified page name must be hard coded. The easiest way to do this is to use immediate substitution such as:<br /> |
|
|
For archives organized by date enter:<br /> |
|
|
<code><nowiki>|archiveprefix={{subst:FULLPAGENAME}}/Archives/</nowiki></code><br /> |
|
|
For numbered archives enter (note <tt>/Archive</tt> instead of <tt>/Archives/</tt>):<br /> |
|
|
<code><nowiki>|archiveprefix={{subst:FULLPAGENAME}}/Archive</nowiki></code><br /> |
|
|
|
|
|
|
|
|
|
|
|
{{anchor|format}}'''format'''<br /> |
|
|
''Type'': string<br /> |
|
|
''Default'': ""<br /> |
|
|
''Description'': This parameter must be set to a valid argument to ]'s function. You may also include an <tt>%%i</tt> value. <tt>%%i</tt> is for numbered archives instead of dated archives, and is replaced with the archive number. Once variable substitution has occurred it will be concatenated onto the end of the value of ''archiveprefix''. The result of the concatenation will be the the name of the archive page(s). See examples. Most commonly, for archives organized by date use:<br /> |
|
|
<code>|format=Y/F</code>. |
|
|
This gives "Archives/2016/January". In order to obtain "Archives/2016/01 (January)", use <code>|format='Y/m (F)'</code>. <br /> |
|
|
For numbered archives use:<br /> |
|
|
<code>|format= %%i</code><br /> |
|
|
Note for date based archives: Cluebot III stores files into a ''single'' archive page each time it runs. With date based archives, the page name is whatever <tt>archiveprefix</tt> concatenated with <tt>format</tt> is for the date that is NOW-age (where age is in hours). For example, if you are starting up YYYY/Month archiving from scratch with many old threads in the page being archived, ClueBot II will put ''all'' of the threads into a single file, not multiple files. If you want a single archiving run to be split into multiple files based on the last date in each thread you will need to use ] (lowercase sigmabot III). |
|
|
|
|
|
===Optional parameters=== |
|
|
|
|
|
These parameters are shaping the behavior of the archiver. |
|
|
|
|
|
{{anchor|archivenow}}'''archivenow'''<br /> |
|
|
''Type'': comma delimited array of strings<br /> |
|
|
''Default'': ""<br /> |
|
|
''Description'': This optional parameter should contain a comma separated list of strings for which ClueBot III will search within the threads on the page. If any of these strings are found in a thread, the bot will archive the thread immediately. The bot will also convert <nowiki>{{templates}}</nowiki> in this list to <nowiki>{{tl|escaped templates}}</nowiki> upon archival. This could be useful for pages where {{tl|resolved}} or such is used. The {{tlu|User:ClueBot III/ArchiveNow}} blank template is available for this use. However, it has no special properties. It is only just another string that happens to be a template for which ClueBot III can be told to search. In addition to the following typical usage, an example of its use is ].<br /> |
|
|
Typical usage: <code><nowiki>|archivenow=<nowiki>{{User:ClueBot III/ArchiveNow}}</nowiki></nowiki></code> |
|
|
<br /> |
|
|
|
|
|
|
|
|
{{anchor|header}}'''header'''<br /> |
|
|
''Type'': string<br /> |
|
|
''Default'': "{{tl|Talkarchive}}"<br /> |
|
|
''Description'': When creating a new archive page, the bot will put this at the top of the new page.<br /> |
|
|
|
|
|
|
|
|
{{anchor|headerlevel}}'''headerlevel'''<br /> |
|
|
''Type'': unsigned integer, between 1 and 7 inclusive<br /> |
|
|
''Default'': 2<br /> |
|
|
''Description'': This is the header level for the threads the bot will archive. Anything on the page before the first header of this level will not be archived. A level 1 header is <code>= Header =</code>, a default thread (level 2) header is <code>== Header ==</code>, and the highest level header is a level 7: <code>======= Header =======</code>.<br /> |
|
|
|
|
|
|
|
|
{{anchor|key}}'''key'''<br /> |
|
|
''Type'': string<br /> |
|
|
''Default'': ""<br /> |
|
|
''Description'': The value of this parameter must match an internally generated key in order for the archives to be stored anywhere other than as subpages of the page being archived.<br /> |
|
|
|
|
|
|
|
|
{{anchor|maxarchsize}}'''maxarchsize'''<br /> |
|
|
''Type'': unsigned integer, greater than 10000<br /> |
|
|
''Default'': 0<br /> |
|
|
''Description'': The target maximum size of the archive in bytes before ''%%i'' (see ''']''') is incremented. If 0, this is disabled. In general, this parameter is used for numbered archives, but not for archives organized by date. This is not a hard limit. Resulting archive page sizes will almost always exceed this number, perhaps by a great amount. Each time ClueBot III runs on a page it archives all threads that are old enough to qualify for archiving into a ''single'' file. If you have <code>maxarchsize=100000</code> with a current archive file size of 90k and it ends up that there are 60 threads to archive with a total size of 250k, then the current archive will be extended to 340k despite of the 100k limit.<br /> |
|
|
|
|
|
|
|
|
{{anchor|maxkeepbytes}}'''maxkeepbytes'''<br /> |
|
|
''Type'': unsigned integer<br /> |
|
|
''Default'': 0<br /> |
|
|
''Description'': If greater than 0, this is the maximum number of thread content bytes to keep on the talk page. Older threads are forcibly archived if there are more than this number of thread content bytes on the page. If 0, this option is disabled.<br /> |
|
|
|
|
|
|
|
|
{{anchor|maxkeepthreads}}'''maxkeepthreads'''<br /> |
|
|
''Type'': unsigned integer<br /> |
|
|
''Default'': 0<br /> |
|
|
''Description'': If greater than 0, this is the maximum number of threads to keep on the talk page. Older threads are forcibly archived if there are more than this number of threads on the page. If 0, this option is disabled.<br /> |
|
|
|
|
|
|
|
|
{{anchor|minarchthreads}}'''minarchthreads'''<br /> |
|
|
''Type'': unsigned integer<br /> |
|
|
''Default'': 0<br /> |
|
|
''Description'': The bot will not archive unless this many or more sections need archival.<br /> |
|
|
|
|
|
|
|
|
{{anchor|minkeepthreads}}'''minkeepthreads'''<br /> |
|
|
''Type'': unsigned integer<br /> |
|
|
''Default'': 0<br /> |
|
|
''Description'': The bot will not archive if there will be this many or less sections left on the page.<br /> |
|
|
|
|
|
|
|
|
{{anchor|nogenerateindex}}'''nogenerateindex'''<br /> |
|
|
''Type'': unsigned integer (boolean)<br /> |
|
|
''Default'': 0<br /> |
|
|
''Description'': If this is set to 1, the bot will not generate an index under ]. There are ''very few'' times this option should be used. If this option is used, the ''']''' option will no longer work right.<br /> |
|
|
|
|
|
|
|
|
{{anchor|numberstart}}'''numberstart'''<br /> |
|
|
''Type'': unsigned integer<br /> |
|
|
''Default'': 1<br /> |
|
|
''Description'': Default value for ''%%i'' in ''']'''.<br /> |
|
|
|
|
|
|
|
|
{{anchor|transformheader}}'''transformheader''' ''Warning! An invalid option here can screw up your archives!''<br /> |
|
|
''Type'': string, <tt>search===replace</tt> pairs delimited by <tt>&&&</tt><br /> |
|
|
''Default'': ""<br /> |
|
|
''Description'': Convert archived thread headers. For each pair, <tt>search</tt> must be a valid regular expression and <tt>replace</tt> is a replacement string. See for more information, <tt>search</tt> corresponds to <tt>$pattern</tt>, <tt>replace</tt> corresponds to <tt>$replacement</tt>, and the thread header corresponds to <tt>$subject</tt>. If you do not understand what this does, don't try to use it. Instead, ask for help from ].<br /> |
|
|
|
|
|
|
|
|
|
|
|
===Cosmetic parameters=== |
|
|
|
|
|
These parameters are shaping the archive box displayed on the page where archiving is active. |
|
|
|
|
|
<!-- DO NOT USE this code on your own page without removing "|nogenerateindex=1". That is in here so an index is not regenerated by ClueBot III for this documentation page.--> |
|
|
{{User:ClueBot III/ArchiveThis|age=999999|archivebox=yes|talkcolor=yes|nogenerateindex=1}} |
|
|
<!-- DO NOT USE this code on your own page. --> |
|
|
{{anchor|archivebox}}'''archivebox'''<br /> |
|
|
''Type'': string ("yes" or "no")<br /> |
|
|
''Default'': "no"<br /> |
|
|
''Description'': Causes an archive box to be displayed similar to {{tl|archive box}}<br /> |
|
|
The example archive box is with non-default value of <code>archivebox=yes</code>. |
|
|
|
|
|
|
|
|
{{anchor|box}}'''box-width''' |
|
|
''Type'': string <br /> |
|
|
''Default'': "238px"<br /> |
|
|
''Description'': The width of the archive box. This parameter is only valid if <code>archivebox=yes.</code><br /> |
|
|
|
|
|
{{clear}} |
|
|
|
|
|
<!-- DO NOT USE this code on your own page without removing "|nogenerateindex=1". That is in here so an index is not regenerated by ClueBot III for this documentation page.--> |
|
|
{{User:ClueBot III/ArchiveThis|age=999999|archivebox=yes|box-advert=yes|talkcolor=yes|nogenerateindex=1}} |
|
|
<!-- DO NOT USE this code on your own page. --> |
|
|
{{anchor|box}}'''box-advert'''<br /> |
|
|
''Type'': string ("yes" or "no")<br /> |
|
|
''Default'': "no"<br /> |
|
|
''Description'': Displays the string "This page is archived by ]." at the bottom of the archive box. This parameter is only valid if <code>archivebox=yes</code>. <br> |
|
|
The example archive box is with non-default value of <code>box-advert=yes</code>. Compare this example to the example next to the ''']''' parameter. |
|
|
{{clear}} |
|
|
|
|
|
<!-- DO NOT USE this code on your own page without removing "|nogenerateindex=1". That is in here so an index is not regenerated by ClueBot III for this documentation page.--> |
|
|
{{User:ClueBot III/ArchiveThis|age=999999|archivebox=yes|box-separator=no|talkcolor=yes|nogenerateindex=1}} |
|
|
<!-- DO NOT USE this code on your own page. --> |
|
|
{{anchor|box}}'''box-separator''' |
|
|
''Type'': string ("yes" or "no")<br /> |
|
|
''Default'': "yes"<br /> |
|
|
''Description'': Display separator lines in the archive box. This parameter is only valid if <code>archivebox=yes</code>. <br> |
|
|
The example archive box is with non-default value of <code>box-separator=no</code>. Compare this example to the example next to the ''']''' parameter. |
|
|
|
|
|
{{clear}} |
|
|
|
|
|
|
|
|
<!-- DO NOT USE this code on your own page without removing "|nogenerateindex=1". That is in here so an index is not regenerated by ClueBot III for this documentation page.-->{{User:ClueBot III/ArchiveThis|age=999999|archivebox=yes|image=]|talkcolor=yes|nogenerateindex=1}}<!-- DO NOT USE this code on your own page. --> |
|
|
{{anchor|image}}'''image'''<br /> |
|
|
''Type'': string<br /> |
|
|
''Default'': "<nowiki>]</nowiki>"<br /> |
|
|
''Description'': If set this is an alternate image file to use as the archive icon in the archive box. This parameter is only valid if <code>archivebox=yes</code>. |
|
|
<br> The example archive box is with non-default value of <code><nowiki>image=]</nowiki></code>. Note that the image size must be specified as part of the argument to this parameter, not with the ''']-width''' parameter. Compare this example to the example next to the ''']''' parameter.<br /> |
|
|
|
|
|
|
|
|
{{anchor|image}}'''image-width''' |
|
|
''Type'': string <br /> |
|
|
''Default'': "40px"<br /> |
|
|
''Description'': The width of the image in the archive box. This parameter is only valid if <code>archivebox=yes</code> '''and''' you are using the default image.<br /> |
|
|
{{clear}} |
|
|
|
|
|
<!-- DO NOT USE this code on your own page without removing "|nogenerateindex=1". That is in here so an index is not regenerated by ClueBot III for this documentation page.-->{{User:ClueBot III/ArchiveThis|age=999999|archivebox=yes|search=no|talkcolor=yes|nogenerateindex=1}}<!-- DO NOT USE this code on your own page. --> |
|
|
{{anchor|search}}'''search''' |
|
|
''Type'': string ("yes" or "no")<br /> |
|
|
''Default'': "yes"<br /> |
|
|
''Description'': Display a search field in the archive box. This parameter is only valid if <code>archivebox=yes</code>.The example archive box is with non-default value of <code>search=no</code>. Compare this example to the example next to the ''']''' parameter.<br /> |
|
|
|
|
|
{{clear}} |
|
|
|
|
|
|
|
|
{{anchor|talkcolor}}'''talkcolor''' / {{anchor|talkcolour}}'''talkcolour''' |
|
|
''Type'': string <br /> |
|
|
''Default'': ""<br /> |
|
|
''Description'': This parameter is only valid if <code>archivebox=yes</code> and the page on which the archive box is displayed is in the <tt>User talk</tt> namespace. If not set, or set to anything other than ''yes'', the color scheme of the archive box on a <tt>User talk</tt> page will not be the standard talk page color scheme. In such a case, the archive box will use the same color scheme as is used for archive boxes on non-talk pages. If this parameter is set to ''yes'' and the page on which the archive box is displayed is in the <tt>User talk</tt> namespace, the archive box will use the standard talk page color scheme.<br/> |
|
|
The two parameters are equivalent, and are only provided to avoid an attrition war in the MOS-style. |
|
|
|
|
|
{{clear}} |
|
|
|
|
|
|
|
|
|
|
|
{{anchor|index}}'''index'''<br /> |
|
|
''Type'': string <br /> |
|
|
''Default'': ""<br /> |
|
|
''Description'': All values of this parameter are equivalent except ''yes''. This parameter should not be set to ''yes'' unless you have wrapped the ClueBot III template with an {{tl|archive box}}. |
|
|
Using <code>index=yes</code> results in the ClueBot III automatically generated index contained on the page <tt>User:ClueBot III/Indices/Talk:YourPage</tt> being ] onto <tt>Talk:YourPage</tt> in place of the {{tlu|User:ClueBot III/ArchiveThis}} template on <tt>Talk:YourPage</tt>.<br /> |
|
|
This parameter is only valid if <code>archivebox=no</code>. If <code>archivebox=yes</code> this parameter has no effect on the index being included in the archive box and does not cause a copy of <tt>User:ClueBot III/Indices/Talk:YourPage</tt> to be ] onto <tt>Talk:YourPage</tt>.<br /> |
|
|
|
|
|
like in <code><nowiki>{{archivebox|{{User:ClueBot III/ArchiveThis|index=yes}}}}</nowiki></code> {{archivebox|{{User:ClueBot III/ArchiveThis|index=yes}}}} |
|
|
{{clear}} |
|
|
|
|
|
|
|
|
==Examples== |
|
|
The following examples can be cut & pasted into the top portion of the page you desire to archive. <nowiki>{{subst:FULLPAGENAME}}</nowiki> will be substituted by the name of the page you are editing when you save the page.<br /> |
|
|
The text explaining the following examples assumes that <nowiki>{{subst:FULLPAGENAME}}</nowiki> evaluates to <tt>Talk:YourPage</tt>. In other words, that <tt>Talk:YourPage</tt> is the page you are archiving.<br /> |
|
|
The age in all of these examples is set t 2160 hours, which is 90 days. If you want a different amount of time, then change the age argument. |
|
|
|
|
|
===Example: Archives by date (without archive box)=== |
|
|
<pre> |
|
|
<nowiki>{{User:ClueBot III/ArchiveThis |
|
|
|archiveprefix={{subst:FULLPAGENAME}}/Archives/ |
|
|
|format=Y/F |
|
|
|age=2160 |
|
|
}}</nowiki> |
|
|
</pre> |
|
|
The archive subpages produced by this example will be in the format of: <br /> |
|
|
<tt>Talk:YourPage/Archives/2013/June</tt><br /> |
|
|
<tt>Talk:YourPage/Archives/2013/July</tt><br /> |
|
|
<tt>...</tt> |
|
|
|
|
|
===Example: Archives by date (with archive box)=== |
|
|
<pre> |
|
|
<nowiki>{{User:ClueBot III/ArchiveThis |
|
|
|archiveprefix={{subst:FULLPAGENAME}}/Archives/ |
|
|
|format=Y/F |
|
|
|age=2160 |
|
|
|archivebox=yes |
|
|
|box-advert=yes |
|
|
}}</nowiki> |
|
|
</pre> |
|
|
The subpages created, as needed, for your archives by this example will be named similar to: <br /> |
|
|
<tt>Talk:YourPage/Archives/2013/June</tt><br /> |
|
|
<tt>Talk:YourPage/Archives/2013/July</tt><br /> |
|
|
<tt>...</tt> |
|
|
|
|
|
===Example: Numbered archives (without archive box)=== |
|
|
<pre> |
|
|
<nowiki>{{User:ClueBot III/ArchiveThis |
|
|
|archiveprefix={{subst:FULLPAGENAME}}/Archive |
|
|
|format= %%i |
|
|
|age=2160 |
|
|
|maxarchsize=150000 |
|
|
|numberstart=1 |
|
|
}}</nowiki> |
|
|
</pre> |
|
|
The subpages created, as needed, for your archives by this example will be named similar to: <br /> |
|
|
<tt>Talk:YourPage/Archive 1</tt><br /> |
|
|
<tt>Talk:YourPage/Archive 2</tt><br /> |
|
|
<tt>...</tt> |
|
|
|
|
|
===Example: Numbered archives (with archive box)=== |
|
|
<pre> |
|
|
<nowiki>{{User:ClueBot III/ArchiveThis |
|
|
|archiveprefix={{subst:FULLPAGENAME}}/Archive |
|
|
|format= %%i |
|
|
|age=2160 |
|
|
|maxarchsize=150000 |
|
|
|numberstart=1 |
|
|
|archivebox=yes |
|
|
|box-advert=yes |
|
|
}}</nowiki> |
|
|
</pre> |
|
|
The subpages created, as needed, for your archives by this example will be named similar to: <br /> |
|
|
<tt>Talk:YourPage/Archive 1</tt><br /> |
|
|
<tt>Talk:YourPage/Archive 2</tt><br /> |
|
|
<tt>...</tt> |
|
|
|
|
|
===Example: By year and numbered (without archive box)=== |
|
|
<pre> |
|
|
<nowiki>{{</nowiki>User:ClueBot III/ArchiveThis |
|
|
|archiveprefix={{subst:FULLPAGENAME}}/Archives/ |
|
|
|format=Y %%i |
|
|
|age=2160 |
|
|
|minarchthreads=0 |
|
|
|minkeepthreads=0 |
|
|
|archivenow=<nowiki><nowiki>{{User:ClueBot III/ArchiveNow}},{{resolved|,{{Resolved|,{{done}},{{Done}}</nowiki></nowiki> |
|
|
|header=<nowiki><nowiki>{{Talkarchive}}</nowiki></nowiki> |
|
|
|headerlevel=2 |
|
|
|nogenerateindex=0 |
|
|
|maxkeepthreads=0 |
|
|
|maxkeepbytes=0 |
|
|
|maxarchsize=150000 |
|
|
|numberstart=1 |
|
|
|archivebox=yes |
|
|
|box-advert=yes |
|
|
<nowiki>}}</nowiki> |
|
|
</pre> |
|
|
The subpages created, as needed, for your archives by this example will be named similar to: <br /> |
|
|
<tt>Talk:YourPage/Archives/2012 1</tt><br /> |
|
|
<tt>Talk:YourPage/Archives/2012 2</tt><br /> |
|
|
<tt>...</tt><br /> |
|
|
<tt>Talk:YourPage/Archives/2013 1</tt><br /> |
|
|
<tt>Talk:YourPage/Archives/2013 2</tt><br /> |
|
|
<tt>...</tt> |
|
|
|
|
|
===Example: Changing from MiszaBot to ClueBot III=== |
|
|
{| class="wikitable" |
|
|
|- |
|
|
! MiszaBot !! ClueBot III |
|
|
|- valign="top" |
|
|
| <pre> |
|
|
<nowiki>{{User:MiszaBot/config |
|
|
|archive = {{subst:FULLPAGENAME}}/Archive %(counter)d |
|
|
|algo = old(90d) |
|
|
|archiveheader = {{aan}} |
|
|
|maxarchivesize = 100K |
|
|
|minthreadsleft = 2 |
|
|
|counter = 20 |
|
|
}}</nowiki> |
|
|
</pre> |
|
|
|| <pre> |
|
|
<nowiki>{{User:ClueBot III/ArchiveThis |
|
|
|archiveprefix={{subst:FULLPAGENAME}}/Archive |
|
|
|age=2160 |
|
|
|header={{aan}} |
|
|
|maxarchsize=100000 |
|
|
|minkeepthreads=2 |
|
|
|numberstart=21 |
|
|
|format= %%i |
|
|
}}</nowiki> |
|
|
</pre> |
|
|
|} |
|
|
The subpages created, as needed, for your archives by this example will be named similar to: <br /> |
|
|
<tt>Talk:YourPage/Archive 21</tt><br /> |
|
|
<tt>Talk:YourPage/Archive 22</tt><br /> |
|
|
<tt>...</tt> |
|
|
|
|
|
The numberstart is one more than the last used by MiszaBot because the first time ClueBot III is run it may be archiving a large number of sections. Increasing this by one will prevent the current archive from being appended. In the case from which this example is taken a 90k archive page was appended by an additional 100k leaving a 190k page for which the max was supposed to be 100k. This has been reported as a bug. |
|
|
|
|
|
Age is in hours, not days. 90 days is 2,160 hours. |
|
|
|
|
|
If you are using an {{tl|Archives}} template, or other template that shows which archiving bot you are using, don't forget to change:<br /> |
|
|
<code><nowiki>{{Archives |auto= short |index= /Archive index |search= yes |bot= </nowiki>'''MiszaBot I'''<nowiki> |age= 90}}</nowiki></code><br /> |
|
|
to:<br /> |
|
|
<code><nowiki>{{Archives |auto= short |index= /Archive index |search= yes |bot= </nowiki>'''ClueBot III'''<nowiki> |age= 90}}</nowiki></code><br /> |
|
