User:Deadbot/Tags: Difference between revisions

Sur (talk | contribs)
initial
 
m Saag moved page User:DeadBot/Tags to User:Deadbot/Tags: Automatically moved page while renaming the user "DeadBot" to "Deadbot"
 
(10 intermediate revisions by one other user not shown)
Line 1: Line 1:
=Overview=
=Overview=
<i>WORK IN PROGRESS, Deadbot uploader is not yet programmed, this is pre-emptive documentation for prototyping the process.</i>
<i>WORK IN PROGRESS, Deadbot uploader is not yet programmed, this is pre-emptive documentation for prototyping the process. All concepts and procedures are experimental.</i>


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.  
Deadbot Tags are indicators used by https://github.com/deadlock-wiki/deadbot that uploads data to the wiki. It tells it where human-edited sections are so that it doesn't edit them.  


=What does a tag look like?=
=What does a tag look like?=
A tag's start looks like
A tag looks like the following. Note that <code><nowiki><!--this--></nowiki></code> is how text is commented out in wikitext.<br>
<pre>
<pre>
<!--deadlocked.wiki/Deadbot Tag, do not edit! Update history Start-->
<!--[[Deadbot Tag]]: Update history Start-->
</pre>
</pre>


While a tag's end looks like
''Note: Not to be confused with [[Changelogs|Changelog Tags]]''
<pre>
<!--deadlocked.wiki/Deadbot Tag, do not edit! Update history End-->
</pre>


=What do tags do?=
=What do tags do?=
Unless otherwise specified, content within tag Start and Ends are written only by Deadbot.
Tags mark content that are edited manually, as opposed to being edited by Deadbot.
 
<br>
<br>
For example, if a page's source is
For example, if a page's source is
Line 22: Line 20:
<pre>
<pre>
<page start>
<page start>
I can do deadlocked.wiki/Deadbot Tagwant!
<deadbot written code>


<!--deadlocked.wiki/Deadbot Tag, do not edit! Update history Start-->
<!--[[Deadbot Tag]]:Introduction Start-->
<h2>{{#invoke:Dictionary|translate|Update history}}</h2>
'''Abrams''' is hard-boiled, hard-hitting bruiser of a character that focuses on engaging groups of enemies and relying on his fortitude and life drain to stay in the fight. With a powerful area stun and a devastating shoulder charge, Abrams can isolate fragile targets from the rest of the team and set-up his more damaging allies to finish them off.
{{#invoke:Changelog|write_changelogs|Shoulder Charge}}
<!--deadlocked.wiki/Deadbot Tag, do not edit! Update history End-->


I can do whatever I want!
A capable and well-known detective of New York, Abrams solved crimes ranging from kidnappings to ritual murders. One day, a mysterious Tome was left on his desk with a note of "Don't let them have it" scrolled in Onyx blood; followed by car bombings and break-ins to his office. Now, Abrams is trying to figure out just what the hell is going on.
<!--[[Deadbot Tag]]:Introduction End-->
 
<more deadbot written code>
<page end>
<page end>
</pre>
</pre>


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.
With the above example, all content between <code>Introduction Start</code> and <code>Introduction End</code> is written manually. For the purposes of this documentation, this is referred to as <b>tagged content</b>. <br>
 
=When to edit content between tags=
Sometimes, Deadbot Tags will have another tag inside them, allowing users to edit them.


For example:
=What is untagged content=
<b>Untagged content</b> refers to content that is not between a Start and End tag. In the previous example, the untagged content is the <code><deadbot written code></code> and <code><more deadbot written code></code>.


<pre>
For pages that utilize Deadbot, untagged content is automatically uploaded by the bot when the page is created.
<page start>
I can do whatever I want!


<!--deadlocked.wiki/Deadbot Tag, do not edit! Ability Start-->
Pages that utilize Deadbot will have at the very top of the page "[[User:DeadBot]]". Most will also have a Deadbot Tag somewhere on the page. Current pages that utilize DeadBot are individual Hero, Ability, and Item pages, such as [[Abrams]], [[Shoulder Bash]], and [[Basic Magazine]].
==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>
</pre>


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 untagged content=
If untagged content is edited, Deadbot will see it as different than expected and repair that section in the page, <b>removing any edits made</b>. This repair does not affect manually written tagged content.


=Editing tags=
=Editing tags=
Do <b>NOT</b> edit the tag.
Do <b>NOT</b> edit the tag.


If a tag is edited, i.e. changing <code>Update history Start</code> to <code>Update History Start</code> 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.  
If a tag is edited, such as, changing <code>Update history Start</code> to <code>Update History Start</code>, it will not be recognized by Deadbot anymore. As a result, all of the enclosed content is subject to being <b>wiped</b> out and re-initialized by Deadbot. All other tagged content will not be edited, however.  


=Editing content between tags=
=Feedback and suggestions=
Unless otherwise specified, do <b>NOT</b> edit content between Start and End tags.
Feedback regarding untagged (meaning botted) content is always welcome! However, as discussed in [[User:DeadBot/Tags#Editing untagged content]], edits cannot be made directly, but rather need to come through the {{Discord}} in the #wiki channel or via the [https://github.com/deadlock-wiki/deadbot DeadBot GitHub].


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.
Ideas regarding tagged (meaning manually written) content is also always welcome! Going through the Discord or GitHub is not necessary, though still recommended. To the concerned page, simply create a Start and End tag (exactly as outlined in the example at [[User:DeadBot/Tags#What do tags do?]]), and all enclosed content can be anything you wish!


=I have a suggestion for content between tags=
<br>If it should be a section that's added to all pages of similar nature, i.e. all Hero pages, then reach out in the Discord to have the DeadBot crew help out and make it a permanent change by adding it to the [[User:DeadBot/blueprints]]!
If you have any ideas or suggestions for better writing content between tags, mention it in the #wiki channel in the {{Discord}}.


The blueprints for each page that uses Deadbot tags can be found at [[Deadbot Tag/blueprints]] (not yet written).
<br>The wiki is constantly growing, with lots of room for expansion. No idea is foolish, so always be willing to share!