User:DeadBot/Tags
Overview
WORK IN PROGRESS, Deadbot uploader is not yet programmed, this is pre-emptive documentation for prototyping the process.
Deadbot Tag is an indicator used by https://github.com/deadlock-wiki/deadbot that uploads data to the wiki. It tells it where a section it can edit starts and ends.
What does a tag look like?
A tag's start looks like
<!--deadlocked.wiki/Deadbot Tag, do not edit! Update history Start-->
While a tag's end looks like
<!--deadlocked.wiki/Deadbot Tag, do not edit! Update history End-->
What do tags do?
Unless otherwise specified, content within tag Start and Ends are written only by Deadbot.
For example, if a page's source is
<page start>
I can do deadlocked.wiki/Deadbot Tagwant!
<!--deadlocked.wiki/Deadbot Tag, do not edit! Update history Start-->
<h2>{{#invoke:Dictionary|translate|Update history}}</h2>
{{#invoke:Changelog|write_changelogs|Shoulder Charge}}
<!--deadlocked.wiki/Deadbot Tag, do not edit! Update history End-->
I can do whatever I want!
<page end>
All content between "Update history Start" and "Update history End" is automatically uploaded by the bot when the page is created, and on occasion to ensure the integrity of previously uploaded pages. Any content outside the tag Start and End can be anything at all, edited by anyone.
When to edit content between tags
Sometimes, Deadbot Tags will have another tag inside them, allowing users to edit them.
For example:
<page start>
I can do whatever I want!
<!--deadlocked.wiki/Deadbot Tag, do not edit! Ability Start-->
==Ability==
{{#vardefine:notes|
<!--deadlocked.wiki/Deadbot Tag, edit only content between Start and End! Notes Start-->
* Siphon Life deals damage in 1 second intervals.
<!--deadlocked.wiki/Deadbot Tag, edit only content between Start and End! Notes End-->
}}
{{#invoke:AbilityData|get_ability_card|Abrams|1|false|{{#var:notes}}}}
<!--deadlocked.wiki/Deadbot Tag, do not edit! Ability End-->
I can do whatever I want!
<page end>
Content between "Notes Start" and "Notes End" can be edited freely by anyone, however, content between "Ability Start" and "Ability End" that isn't also in the Notes section should not be edited.
Editing tags
Do NOT edit the tag.
If a tag is edited, i.e. changing Update history Start to Update History Start it will not be recognized by Deadbot anymore. As a result, that section and any content not within tags will be wiped out and re-initialized by Deadbot.
Editing content between tags
Unless otherwise specified, do NOT edit content between Start and End tags.
If content between Start and End tags are edited where its not specified as allowed, Deadbot will see it as different than expected and repair that section in the page, removing any edits made.
I have a suggestion for content between tags
If you have any ideas or suggestions for better writing content between tags, mention it in the #wiki channel in the Discord community server.
The blueprints for each page that uses Deadbot tags can be found at Deadbot Tag/blueprints (not yet written).