General Information
Making a Knowledge Base Entry
Contributors:
Hamid Hussain
Hamid Hussain
This article describes how to format other articles in the Knowledge Base. It specifies how each segment of an article should be made, in order of its appearance. This includes rules on general format, as well as the headers and content sections.
This page can be used as a template for other articles as a shorthand for the style requirements it denotes.
If you want to edit the Knowledge Base, you must first be able to access our Google Drive and the Google Sites web app. Instructions for how to get set up with Google software can be found in the article linked on the right.
After your Google Workspace is set up, you can start editing the website by loading the web editor in one of two ways:
This button will appear on every page when viewing the Knowledge Base website. Clicking it will redirect you to the editor where you can edit the article that you came from or any other.
The website can be accessed through the Electric Mayhem shared drive. It looks like this and should be in the "Knowledge Base" directory of the shared drive.
After you reach the editor, use it to make edits or new articles for the Knowledge base by following the rules below.
All sections should use Style 1 of the provided global theme.
Only Introductions and Section Headers may use the Header style. Headings inside of sections must use the Subheading style.
Information in content sections should be presented concisely and organized in a way that is logical and easy to parse.
Text formatting should be limited to the presets provided, such as Normal text, Title, etc.
Any code blocks inserted into entries should be formatted as code through the text menu at the top of the text area.
The banner of an article must be set to Title Only, or Banner if an appropriate image is available. The article's title should be concise and displayed as the preset text format Title.
Above the main title, a centered line of type Subheading should denote the category of the article. Subgroups should be notated through ">" symbols. e.g. "Mechanical > FTC"
Underneath the main title, a left-aligned line of type Heading should read: "Contributors:"
Under this heading,any major contributors must be credited, their names listed and separated by commas.
The area of the heading text box should not be altered.
The introduction is a text box with a line of type Heading reading "Introduction" followed by text on following lines.
This text box should take up the left half of the horizontal block space, with a table of contents element filling the rest.
The introduction is to appear immediately after the header section and should summarize the purpose and contents of the article.
The introduction text should be concise, ideally 1-2 short paragraphs.
Every section should begin with a full-width textbox of type Heading
This heading must start with "Section # | " followed by a title. # is an incrementing number.
After these two required items, any other elements can be placed, such as embeds and content blocks.
The header text block must contain only the header, any immediately following text must be contained within a separate block.
In this article, sections are completely text-based and consist of short bulleted sentences.
Other articles may use advanced layout configurations, content blocks, and embedded media.
This is an example of a content block, an advanced layout option available for use in sections. It appears under the quick select options in the Insert tab of the editor, and contains one or more placeholders such as the one on the left, where images, embeds, etc. can be placed.
public static void main(String[] args) {
System.out.println("Hello, World!");
}
This layout is not a pre-made content block, but rather multiple elements side-by-side in a single block. Layouts such as these can be made by resizing one element and dragging another to either side of it.
Here is a link to a sample page that names all the formatted elements: