User:Rizbot: Difference between revisions
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
{{/login}} | {{/login}} | ||
== Functionality == | == Functionality and scope == | ||
This bot is a work-in-progress. | This bot is a work-in-progress. The bot is planned to update parts of the following pages automatically: | ||
* [[Rizline:List of songs]] | * [[Rizline:List of songs]] | ||
* Pages in [[:Category:Rizline songs]] | * Pages in [[:Category:Rizline songs]] | ||
** RizlineSongInfoBox templates | ** Uses of [[Template:RizlineSongInfoBox|RizlineSongInfoBox]] templates | ||
** Song statistics - note counts, colors, etc. | ** Song statistics - note counts, colors, etc. | ||
** Asset tables | ** Asset tables | ||
The sections that the bot should edit are marked with special tags within HTML comments: | == Usage == | ||
The sections that the bot should edit are marked manually with special tags within HTML comments: | |||
* <code><nowiki><!-- ##</nowiki> RIZ<nowiki/>BOT <nowiki/> BEGIN section_type <nowiki>## --></nowiki></code>, and | * <code><nowiki><!-- ##</nowiki> RIZ<nowiki/>BOT <nowiki/> BEGIN section_type <nowiki>## --></nowiki></code>, and | ||
* <code><nowiki><!-- ##</nowiki> RIZ<nowiki/>BOT <nowiki/> END section_type <nowiki>## --></nowiki></code>, | * <code><nowiki><!-- ##</nowiki> RIZ<nowiki/>BOT <nowiki/> END section_type <nowiki>## --></nowiki></code>, | ||
where <code>section_type</code> is the type of the section that the bot should generate (for example, <code>rizline_song_info_box</code>, or <code>rizline_song_stats</code>). | where <code>section_type</code> is the type of the section that the bot should generate (for example, <code>rizline_song_info_box</code>, or <code>rizline_song_stats</code>). Additional space-separated arguments may be added after the <code>section_type</code> in the <code>BEGIN</code> marker. | ||
The bot searches the wiki for these markers, and finds the appropriate function to use. It then replaces the text between the <code>BEGIN</code> and <code>END</code> markers with generated content. If the content is different from what it was originally, the bot makes an edit and saves the new version of the page. | |||
'''Warning:''' It is important to remember that anything that is between the <code>BEGIN</code> and <code>END</code> markers will be overwritten. Manual changes to the content in-between the markers will be lost when the bot will be launched again. | |||
=== Rizline Song Info Box (rizline_song_info_box) === | |||
To generate a song info box using Rizbot, use the following syntax: | |||
<pre> | |||
<nowiki><!-- ##</nowiki> RIZ<nowiki>BOT</nowiki> BEGIN rizline_song_info_box RizlineSongID <nowiki>## --></nowiki> | |||
<nowiki><!-- ##</nowiki> RIZ<nowiki>BOT</nowiki> END rizline_song_info_box <nowiki>## --></nowiki> | |||
</pre> | |||
where <code>RizlineSongID</code> should be replaced with the internal ID of the song (level) that the infobox should generate the data of (for example, <code>PastelLines.RekuMochizuki.0</code>). | |||
Revision as of 20:12, 5 January 2025
A bot created by User:TadeLn that automatically updates Rizline data on the wiki.
Status
Last Login
Last login to Rizbot occurred at: 2025-01-10T18:35:41.947939211Z (using mediawiki-rizbot)
Functionality and scope
This bot is a work-in-progress. The bot is planned to update parts of the following pages automatically:
- Rizline:List of songs
- Pages in Category:Rizline songs
- Uses of RizlineSongInfoBox templates
- Song statistics - note counts, colors, etc.
- Asset tables
Usage
The sections that the bot should edit are marked manually with special tags within HTML comments:
<!-- ## RIZBOT BEGIN section_type ## -->, and<!-- ## RIZBOT END section_type ## -->,
where section_type is the type of the section that the bot should generate (for example, rizline_song_info_box, or rizline_song_stats). Additional space-separated arguments may be added after the section_type in the BEGIN marker.
The bot searches the wiki for these markers, and finds the appropriate function to use. It then replaces the text between the BEGIN and END markers with generated content. If the content is different from what it was originally, the bot makes an edit and saves the new version of the page.
Warning: It is important to remember that anything that is between the BEGIN and END markers will be overwritten. Manual changes to the content in-between the markers will be lost when the bot will be launched again.
Rizline Song Info Box (rizline_song_info_box)
To generate a song info box using Rizbot, use the following syntax:
<!-- ## RIZBOT BEGIN rizline_song_info_box RizlineSongID ## --> <!-- ## RIZBOT END rizline_song_info_box ## -->
where RizlineSongID should be replaced with the internal ID of the song (level) that the infobox should generate the data of (for example, PastelLines.RekuMochizuki.0).