Jump to content

User:Orgullobot/commands/documentation

From Meta, a Wikimedia project coordination wiki

This is something new to Commons. User:Orgullobot/commands is a protected page that User:Orgullobot reads periodically (twice per minute) to retrieve and perform the tasks indicated there. It is hoped that with this new implentation that Commoners will have to do less tedious work and will be able to concentrate specifically and only on things that absolutely require human presence. If you are not a sysop, you can add your requests here or ask any of the many that you may see in recent changes to edit the page with your request.

Rules:

  1. Commands must always be protected. We don't want to give just anyone the power to control the bot, that would be dangerous.
  2. You must be sure about what you're doing before you edit Commands.
  3. Indicate the desired changes only as described here. Do not try to get something done by "tricking" the bot.
  4. Commands doesn't need to look pretty, it doesn't matter in the least bit.
  5. Put one command per line.


Available commands

[edit]

Rename a category

[edit]

To rename (move) a category to another, use the template {{move cat|cat1|cat2}}. Do not include the namespace here. To move Category:New York to Category:New York state, for example, you would put {{move cat|New York|New York state}}: Template:Move cat


To orphan an image

[edit]

To orphan an image on Commons, use {{orphan|Name_of_the_image}}. If you wanted to orphan, for example, Image:Flag of Spain.svg:

Template:Orphan Note that the bot will only edit pages in the namespaces "Category", "Template", and "0" (mainspace) and that it is impossible for this to be 100% accurate, but it's close.

To replace one image with another

[edit]

To replace one image with another, use {{replace image|Name_of_the_image_you_want_to_replace|Name_of_the_new_image}}:

{{replace image|Spain flag 300.png|Flag of Spain.svg}}

Template:Replace image


To insert a fixed text into all the pages in a category

[edit]

This is especially useful for inserting templates, but it can also be used for other things. This function is not called with templates like the others because that would confuse the bot. Instead, we use tags something like HTML. They are the following:

  • <fixed text>, </fixed text> - To iniciate and conclued the commmand.
  • <cat>, </cat> - To define the category in which to work.
  • <text>, </text> - To define the text to insert in the pages.

If we put, for example: <fixed text><cat>New York</cat><text>Hello, world!</text></fixed text> in /commands, the bot will edit all the pages in Category:New York to insert "Hello, world".

Note:

  • This function is very new and may have some bugs. It's handy to have a sysop around to block if the bot goes crazy.
  • The bot will insert the text right between the article text (if there is any) and the interwikis and categories.

To send a message to many people

[edit]

For the bot to leave a certain message on a number of people's talk pages, use {{bulletin|message|list}}, where message is the name of the page where your message is located and list is the name of the page where there is a list of the users you want to send it to. Message and list should not be in brackets ([[*]]), and the names in the list page should also be "raw", with no links, that is. An example follows:

{{bulletin|User:Orgullobot/commands/message (example)|User:Orgullobot/commands/list (example)}}

Template:Bulletin The message page should include your signature, as Orgullobot will not be signing the message.

New ideas, improvments, comments, problems, etc.

[edit]

Don't hesitate to contact Orgullomoore to ask a question, make a comment, propose a new idea/function, or to complain about a mistake the bot made. This is very new and will require lots of work.