Wiki Rules / How to Contribute

Important: if you'd like to contribute to the Wiki, please read here first.

Rules / Guidelines

Please read and understand these rules before contributing content to the Wiki.

Rules / Guidelines

Rules for Wiki Editors

The rules below will be strictly enforced. Please review before contributing content to the Wiki. 

Rules for Wiki Editors

In order to maintain a high quality of content, the rules below will be strictly enforced. These rules should be considered a work in progress, they may be edited or revised at a future date.

  1. No self-promotion: This wiki should not be used for the purpose of advertising your mods, YouTube channel, or anything else of that nature. This will be strictly enforced. 
  2. Do not post copyrighted material: Posting copyrighted material (such as images or videos) will expose this website and its owners to legal liability. As a result, any user that posts copyrighted material will have their editing privileges immediately and permanently revoked.
  3. Do not post other people's content: Similar to the above, we can't verify whether you have permission to post this content, so please don't.
  4. Do not spam or post low-quality material: Think of this like an encyclopedia or knowledgebase for future generations of modders. Please proofread your content and avoid submitting low-quality material as much as reasonably possible. 
  5. No swearing, slang, "adult language", or any kind of vulgar or offensive content will be tolerated.
  6. All original content published on the wiki is considered Public Domain: By publishing original content here, you are releasing it to the Public Domain. This means it may be revised, edited, or reworked as needed by other members of the community.

Last edited September 7, 2021.

Rules / Guidelines

Quality Guidelines

In order to ensure high quality content, any submissions not meeting these criteria may be edited or removed.

Quality Guidelines

If you haven't already, please first read the Rules for Wiki Editors as these are very important, and strictly enforced. By contrast, these "guidelines" are not enforced as strictly, but still recommended to follow whenever possible.

  1. In general, think of this wiki as an encyclopedia or knowledgebase. The goal is to record our knowledge — to make information more accessible, and to preserve this knowledge for the future. Articles should be written with this goal in mind.
  2. Articles should be written from a neutral point of view. You should try to avoid writing content that uses emotionally-charged language or subjective opinions. To test your understanding of this concept, it may be helpful to try the Wikipedia Neutrality Quiz.
  3. Avoid writing from the first-person perspective. In most cases, wiki articles are not published with the authors name, and will be edited by many different individuals. For this reason, you should avoid using the word "I" in your content. Similarly, avoid using phrases like "personally", "in my opinion", etc.
  4. Avoid duplicate content. In general, its a good idea to use the "search" features to see if someone has already written about your topic. Consider adding to the existing content (rather than starting a new page) if it makes sense to do so.
  5. Proofread your content before publishing. Please check for common errors like typos, etc. 

Last edited September 8, 2021.

Rules / Guidelines

Requesting "Editor" Access

Please send a message to SamPT#9513 on Discord to have an account made for you. For now, all editor accounts need to be manually approved by a site administrator. 

We encourage anyone with knowledge about modding Doom Eternal or Doom 2016 to contribute to the wiki by becoming a content editor.

Tips for Wiki Editors

Useful tips for editing wiki content

Tips for Wiki Editors

Keyboard Shortcuts

The following shortcuts are available in the WYSIWYG Editor:

Shortcut (Windows & Linux/Mac) Description
Ctrl+S / Cmd+S Save Draft
Ctrl+Enter / Cmd+Enter Save Page & Continue
Ctrl+B / Cmd+B Bold
Ctrl+I / Cmd+I Italic
Ctrl+U / Cmd+U Underline
Ctrl+1 / Cmd+1
Ctrl+2 / Cmd+2
Ctrl+3 / Cmd+3
Ctrl+4 / Cmd+4
Header Large
Header Medium
Header Small
Header Tiny
Ctrl+5 / Cmd+5
Ctrl+D / Cmd+D
Normal Paragraph
Ctrl+6 / Cmd+6
Ctrl+Q / Cmd+Q
Blockquote
Ctrl+7 / Cmd+7
Ctrl+E / Cmd+E
Code Block
Ctrl+8 / Cmd+8
Ctrl+Shift+E / Cmd+Shift+E
Inline Code
Ctrl+9 / Cmd+9 Callout
(Keep pressing to toggle through styles)
Tips for Wiki Editors

Reusing Page Content

How to use include tags to reuse pages and page content within other pages.

You may find that you want to include the same block of content in multiple places. You could copy and paste that content into multiple pages but then, if that content needs to be changed, you'd have to update it multiple times across different pages. By using include tags you can include entire other pages and also include single blocks of content from other pages.

Note that the include behaviour is non-recursive so including will only work to a single level. This ensures performance and prevents users from breaking pages by creating include loops.

Include Tags

To include the content of a page within another you can use the following syntax:

{{@page_id}} or {{@page_id#content_id}}

You simply enter that in the page editor and then, when the page is viewed, the content will be dynamically be fetched. This means you can update the referenced content and it will show the same changes on any page the content is included within.

Easily Grabbing the Syntax

Finding the id of a page can be difficult so a quick and easy way to find include tags is built-in. View a page with some content you want to re-use. Use your mouse to select some content and you will see a popup appear. By default this contains a direct link to that content. If you click the link icon on the left it will switch to show you the include tag for that content. Simply copy that and place it in another page. Remove the # and content id to include the whole content of the page instead of just a single block.

Forcing Content IDs

When including a specific block of content the id of the block is used (part after the hash). By default these are generated when you save a page. If you are using the WYSIWYG editor the id will stay the same unless the block is removed or re-formatted. In the markdown editor it changes with every save based on the content so while it may remain the same there's a good chance an ID can change therefore it's recommended to force an ID if you're using the content for includes.

Note: All ID values must start with "bkmrk" to avoid being overwritten.

WYSIWYG Editor

In the WYSIWYG editor you can force an ID by going into the source code view and adding it manually:

forcing-wysiwyg-ids.png



Tips for Wiki Editors

Searching Content

The ability to search your documentation is vital to day-to-day use.

There are a few locations within BookStack where you can search for your content. Below is a list of search functions within BookStack:

Advanced Search Syntax

All of the above search locations within BookStack share the ability to use advanced search syntax. An easy way to see this syntax in action is to use the global search in BookStack then play with the search filters which will update the search term with the below syntax. Below are details of the different types of syntax that can be used:

Search Type Syntax Examples Description
Normal Searches <term_a> <term_b> london meeting Normal word searches across the name and description or body of your content. When mulitple terms are searched only one term has to match your content but content containing both terms will be higher in the results.
Exact Searches "<term>" "london meeting" Exact matches will require that the whole string within quotes exists in your content in exactly the same format. Use this if you're looking for an exact phrase containing or if you need to search for a term with spaces in.
Tag Searches [<name>]
[<operator><value>]
[<name><operator><value>]
[location]
[=london]
[location=london]
[attendees>5]
Tag searches allow you to find pages which have specific tags applied. You can search by tag name, by tag value or by both name and value. When searching by tag value an operator must be used to define the match type. You can use =, !=, <, >,<=, >= or like as operators. When using the like operator you can use % symbols to represent wildcards in your search.
Filter Searches {<filter_name>}
{<filter_name>:<filter_value>}
See below Filters perform additional advanced functionality to make your searches even more powerfull. Some filters take values but some don't need to. See below for a full list of filters available.

Available Filters

Filters are set advanced search features that can be used in your search term. The below table shows all the filters available in BookStack and how they can be used.

Syntax Examples Description
Date Filters
{updated_after:<date>} {updated_after:2016-12-30} Adds the condition that the content must have been last updated after the given date.
The date should be in the format YYYY-MM-DD
{updated_before:<date>} {updated_before:2016-12-30} Adds the condition that the content must have been last updated before the given date.
The date should be in the format YYYY-MM-DD
{created_after:<date>} {created_after:2016-12-30} Adds the condition that the content must have been created after the given date.
The date should be in the format YYYY-MM-DD
{created_before:<date>} {created_before:2016-12-30} Adds the condition that the content must have been created before the given date.
The date should be in the format YYYY-MM-DD
User Filters
{updated_by:<user_slug|me>} {updated_by:barry}
{updated_by:me}
Adds the condition that the content must have been last updated by the user of the given slug. If 'me' is used in place of a slug then it will find content that was last updated by the current logged-in user.
{created_by:<user_slug|me>} {created_by:barry}
{created_by:me}
Adds the condition that the content must have been created by the user of the given slug. If 'me' is used in place of a slug then it will find content that was created by the current logged-in user.
{owned_by:<user_slug|me>} {owned_by:barry}
{owned_by:me}
Adds the condition that the content must have be actively owned by the user of the given slug. If 'me' is used in place of a slug then it will find content that is owned by the current logged-in user.
Content Filters
{in_name:<search>} {in_name:London Meetings}
{in_name:Meetings}
Will require the content to have the given <search> term in the name rather than the name or content body.
{in_body:<search>} {in_body:London Meetings}
{in_body:Meetings}
Will require the content to have the given <search> term in the body rather than both the name or content body.
Option Filters
{is_restricted} {is_restricted} Will require the content to have content-level permissions active. Does not return items with only inherited asset permissions.
{viewed_by_me} {viewed_by_me} Will require the content to have been viewed by the current user at least once.
{not_viewed_by_me} {not_viewed_by_me} Will not return any content that has been viewed by the current user.
{type:<content_types>} {type:page|chapter|book}
{type:page|chapter}
{type:book}
Restricts the types of content that will be in the search results.
Use of this will depend on the type of search. For example, in a chapter search only pages are shown so this has no effect.

Search Examples

Below are some examples of using the above syntax and filters with descriptions: 

Legal Disclaimer

DOOM Eternal, id, id Software and related logos are registered trademarks or trademarks of id Software LLC. Bethesda, Bethesda Softworks, ZeniMax and related logos are registered trademarks or trademarks of ZeniMax Media Inc. 

The Doom Eternal Modding Wiki is a fan-made website. We claim no ownership of, nor affiliation with, any of the trademarks or organizations listed above. This website and all associated operations are purely non-profit and educational in nature. We do not sell any product or service, nor solicit funding or donations of any kind.

This website and the information contained herein is protected under Fair Use: Copyright Disclaimer Under Section 107 of the Copyright Act in 1976; Allowance is made for "Fair Use" for purposes such as criticism, comment, news reporting, teaching, scholarship, and research. Fair use is a use permitted by copyright statute that might otherwise be infringing. Non-profit, educational or personal use tips the balance in favor of fair use. All rights and credit go directly to its rightful owners. No copyright infringement intended.

Last updated September 8, 2021.