User:Deadbot/Tags: Difference between revisionsGive feedback
initial |
m reworked; tags now only exist for content that can be edited, rather than for content that cant be edited. |
||
| 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 | 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 | A tag looks like the following. Note that <code><!--this--></code> is how text is commented out in wikitext.<br> | ||
<pre> | <pre> | ||
<!-- | <!--[[Deadbot Tag]]: Update history Start--> | ||
</pre> | </pre> | ||
=What do tags do?= | |||
Content inside of a tag Start and End are edited manually, not by Deadbot. | |||
<br> | <br> | ||
For example, if a page's source is | For example, if a page's source is | ||
| Line 22: | Line 18: | ||
<pre> | <pre> | ||
<page start> | <page start> | ||
<deadbot written code> | |||
<!-- | <!--[[Deadbot Tag]]:Introduction Start--> | ||
'''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. | |||
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> | ||
With the above example, all content between <code>Introduction Start</code> and <code>Introduction End</code> is written manually. <br> | |||
< | |||
< | |||
=What is untagged content= | |||
Untagged content 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>. | |||
< | |||
< | |||
For pages that utilize Deadbot, untagged content is automatically uploaded by the bot when the page is created. | |||
Pages that utilize Deadbot will have at least 1 Deadbot Tag somewhere on the page. This will at minimum include individual Hero, Ability, and Item pages, such as [[Abrams]], [[Shoulder Bash]], and [[Basic Magazine]]. | |||
=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, | 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, all of the enclosed content is subject to being <b>wiped</b> out and re-initialized by Deadbot. | ||
=Editing content | =Editing untagged content= | ||
Occasionally, Deadbot will ensure the integrity of previously uploaded pages by <b>overwriting untagged content</b>. | |||
If content | If untagged content is edited, 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 | =I have a suggestion for untagged content= | ||
If you have any ideas or suggestions for better writing content between tags, mention it in the #wiki channel in the {{Discord}}. | If you have any ideas or suggestions for better writing content or code between tags, mention it in the #wiki channel in the {{Discord}}. We would love to hear your feedback! | ||
The blueprints for | The blueprints for pages that use Deadbot tags can be found at [[Deadbot Tag/blueprints]] (not yet written). | ||
Revision as of 04:02, 12 October 2024
Overview
WORK IN PROGRESS, Deadbot uploader is not yet programmed, this is pre-emptive documentation for prototyping the process. All concepts and procedures are experimental.
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?
A tag looks like the following. Note that is how text is commented out in wikitext.
<!--[[Deadbot Tag]]: Update history Start-->
What do tags do?
Content inside of a tag Start and End are edited manually, not by Deadbot.
For example, if a page's source is
<page start> <deadbot written code> <!--[[Deadbot Tag]]:Introduction Start--> '''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. 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>
With the above example, all content between Introduction Start and Introduction End is written manually.
What is untagged content
Untagged content refers to content that is not between a Start and End tag. In the previous example, the untagged content is the <deadbot written code> and <more deadbot written code>.
For pages that utilize Deadbot, untagged content is automatically uploaded by the bot when the page is created.
Pages that utilize Deadbot will have at least 1 Deadbot Tag somewhere on the page. This will at minimum include individual Hero, Ability, and Item pages, such as Abrams, Shoulder Bash, and Basic Magazine.
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, all of the enclosed content is subject to being wiped out and re-initialized by Deadbot.
Editing untagged content
Occasionally, Deadbot will ensure the integrity of previously uploaded pages by overwriting untagged content.
If untagged content is edited, Deadbot will see it as different than expected and repair that section in the page, removing any edits made.
I have a suggestion for untagged content
If you have any ideas or suggestions for better writing content or code between tags, mention it in the #wiki channel in the Discord community server. We would love to hear your feedback!
The blueprints for pages that use Deadbot tags can be found at Deadbot Tag/blueprints (not yet written).