Blooncyclopedia:Hidden comments: Difference between revisions
m how did no one point out this typo |
|||
| Line 1: | Line 1: | ||
Blooncyclopedia allows editors to insert HTML comments in article text. This is done by inserting <code><!--</code> and <code>--></code> before and after the text, respectively. This text shows up in both the source editor and visual editor, but not when the page is rendered. | Blooncyclopedia allows editors to insert HTML comments in article text. This is done by inserting <code><!--</code> and <code>--></code> before and after the text, respectively. This text shows up in both the source editor and visual editor, but not when the page is rendered. | ||
Comments are useful for guiding other editors or | Comments are useful for guiding other editors or alerting them to potential mistakes or technical issues that could happen when editing a section, without disrupting the text for readers. Comments should not be used for questions, matters pertaining only to yourself, or matters that don't pertain to wiki editing. It is better to group comments together rather than splitting them up into multiple smaller comments, because they can make editing wiki pages more cumbersome (especially in the visual editor). | ||
==Appropriate uses of comments== | ==Appropriate uses of comments== | ||
Latest revision as of 05:15, 20 February 2026
Blooncyclopedia allows editors to insert HTML comments in article text. This is done by inserting <!-- and --> before and after the text, respectively. This text shows up in both the source editor and visual editor, but not when the page is rendered.
Comments are useful for guiding other editors or alerting them to potential mistakes or technical issues that could happen when editing a section, without disrupting the text for readers. Comments should not be used for questions, matters pertaining only to yourself, or matters that don't pertain to wiki editing. It is better to group comments together rather than splitting them up into multiple smaller comments, because they can make editing wiki pages more cumbersome (especially in the visual editor).
Appropriate uses of comments
| Use | Example |
|---|---|
| Instructions to help other editors |
|
| Justifying editing decisions | <!-- It is capitalized like this in the preview video --><!-- See [[Forum:Village pump]] for the reason this section was trimmed -->
|
| Article text that will probably be uncommented in the future (due to updates, categories for drafts/sandbox pages, etc) | <!-- {{BCS change list by name|Regrow Potion}} --><!-- [[Category:Game mechanics in BTD6]] -->
|
Inappropriate uses of comments
| Use | Example |
|---|---|
Commentary or questions that are better for (and more likely to get a response on) talk pages or {{research}} notices
|
<!-- Is this the correct ability cooldown? --><!-- Not sure -->
|
| Personal opinions, editorializing, or other remarks that have nothing to do with wiki editing | <!-- This tower sucks --><!-- Why won't NK fix this? -->
|
| Personal reminders | <!-- I forgot what I wanted to write here -->
|
| Telling others not to edit something without a justification (like a writing policy or technical issue) | <!-- This section doesn't need to be changed -->
|
| Vandalism, threats, or other comments that go against the code of conduct | <!-- If you edit this section you will explode in real life -->
|
Navigation
| Blooncyclopedia | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|