Drupal Training Guide and Best Practices for Content Editors

Tags Drupal

Intro

Drupal is a content management system (CMS) used to build and maintain websites, web applications and more. It provides standard features like easy content authoring, reliable performance, and security. Drupal also provides the ability to extend its functionality with contributed modules and themes; you can use contributed modules or create your own. The Drupal project is open source software and anyone can download, use, work, and share it. The Drupal community has more than a million developers, designers, trainers, strategists, coordinators, editors, and sponsors working together. You can read more about Drupal at drupal.org.

 

Environment

Access is granted when a new designated Communications Managers or Website Content Editor is hired or assigned. Users can use a Linux, Mac, or Windows computer with most modern browsers being supported. For the most up-to-date list of browsers refer to Drupal's documentation on browser requirements.

Supported Browsers

  • Desktop
    • Firefox
    • Google Chrome
    • Microsoft Edge
    • Opera
    • Safari
  • Mobile
    • Chrome for Android
    • Chrome for iOS
    • Opera Mini (except for 'extreme data savings' mode)
    • Samsung Internet
    • Safari for iOS

 

Topics

 

 

 

 

 

 

Logging In

 

VPN

All users must be logged into the Drupal website and MSU’s virtual private network (VPN) to edit content.

If you are not logged into the VPN, you will receive a “403 Forbidden” message when trying to add or edit content.

MSU’s VPN software, F5 Big-IP Edge is installed on your SLE computer. Open this application and login with your MSU NetID (MSU email and password). You can also login to the VPN in a browser by navigating to new.vpn.msu.edu. Read more on the Knowledge Base article “Using MSU’s Virtual Private Network.”

 

 

Administrative Toolbar

The administrative (admin) toolbar gives you quick access to the most important administrative pages. As a Content Editor you will mainly use the Content tab in the admin toolbar to add, edit, and view pages and content types.

Drupal administrative toolbar

  • Drupal Icon – This will always take you to the website homepage.
  • Content Tab – Where you can find, manage, and create new pages or content types.

 

 

Text Editor

Drupal uses a text editor called CKEditor. It is a what you see is what you get (WYSIWYG) editor.

Note
Copying and pasting directly from Microsoft Word, Excel, Outlook, any other program, or website into the web editor will make the pasted text look not as intended and will make future edits difficult. Please paste as Plain Text, Ctrl + Shift + V (Windows) or Cmd + Shift + V (macOS), or paste the text into a Plain Text editor like Notepad (for Windows, or TextEdit on macOS) and then copy and paste into CKEditor.

 

Text Editor Toolbar

CKEditor text editor bar

Bold
Use this feature for emphasis. Please do not use all caps.

 

Italic
Use this feature sparingly as it's very difficult to read on phones. Use Bold for emphasis.

 

Link / Unlink
The link feature lets you insert hyperlinks into your content and provides a UI to create and edit them. Use the unlink button to remove a hyperlink.

 

Bulleted list
The bulleted list feature lets you create unordered (bulleted) lists. You can use unordered lists where it is not that important (as in a list of ingredients). It's easiest to put your text into CKEditor first and then highlight the text and click this button.

 

Numbered list
The numbered list feature lets you create ordered lists. You can use ordered lists where the order of the items matters (as in instructions). It's easiest to put your text into CKEditor first and then highlight the text and click this button.

 

Blockquote
The block quote feature lets you easily include block quotations or pull quotes in your content. It’s also an attractive way to draw the readers’ attention to selected parts of the text.

 

Image
The image feature is used to add images in the body. You can align the image left, center, or right. Image alternative text is required.

 

Horizontal line
The horizontal line feature lets you visually divide your content into sections by inserting horizontal lines (also known as horizontal rules). It is an easy way to organize the content or indicate a change of topic.

 

Show Blocks
The show blocks feature allows the content creators to visualize all block-level elements (except for widgets) by surrounding them with an outline and displaying their element name at the top-left corner of the box.

 

Headings
The heading feature helps you structure your document by adding headings to parts of the text. They make your content easier to scan by both readers and search engines.

 

Undo / redo
The undo / redo feature lets you withdraw recent changes to your content as well as bring them back, just like in Microsoft Word. You can also selectively revert past changes, not just the latest ones.

  • Undo
    • Ctrl + Z (Windows)
    • Cmd + Z (macOS)
  • Redo
    • Ctrl + Y or Ctrl + Shift + Z (Windows)
    • Cmd + Y or Cmd + Shift + Z (macOS)

Indent / Outdent
The block indentation feature lets you set indentation for text blocks such as paragraphs, headings, or lists. This way you can visually distinguish parts of your content.

 

Paste as plain text
With the plain text pasting feature, text pasted using the Ctrl + Shift + V (Windows) or Cmd + Shift + V (macOS) keystroke will match the formatting of the content you paste it into. This is used to paste your text as plain text, if your browser supports it. Chrome does not support this function.

 

Maximize
This will expand CKEditor to take up the entire width and height of your browser which maximizes the editing area.

 

Source Editing
The source editing feature lets you view and edit the source of your document. You can toggle your view between HTML and Rich Text.

 

 

Quick Tips: Online Content Accessibility

 

Text and Contrast

Check that text has a strong contrast against the page background.

 

Text Styles

Use more than color to denote differences, emphasis, and content meaning.

 

Heading Styles

Use descriptive heading styles to designate content organization.

 

List Styles

Use bulleted or numbered list styles to denote list structure.

 

Alternative Text

Provide alternative text for images, graphs, and charts.

 

Multiple Avenues for Multimedia

Supply multiple avenues for multimedia content (e.g., audio with a transcript or video with captioning).

 

Added Context

  • Use descriptive titles, headers, and link text to provide added context.
  • Do not rely solely on references to shape, size, or position to describe content.

 

Tables

Format and use simple tables with column and row headers.

 

 

Editorial Guidelines

Below is a list of the most commonly used entries. Please refer to the MSU Editorial Style Guide and MSU Inclusive Guide for additional resources.

Acronyms

Spell out the first reference with the acronym in parentheses. All additional references, use the acronym.

 

Ampersand

Do not use unless it is part of the property. For example, FO&M.

 

And / Or

"Or" will fill most needs.

 

Comma

Required when setting off a word or phrase that is added in a parenthetical way. In a series, use a comma before the conjunction (name, address, and phone number). With suffixes, do not use a comma before Jr., Sr., II, III.

 

Dates

We follow AP Style for dates and times. Do not use nd, rd or th after a date. Just use the numeral.

 

Day of the Week

Do not abbreviate days of the week.

 

Department Names

Do not need to be capitalized unless it refers to the formal name of a department.

 

Examples

  • System output is in roman font type.
  • User input is in bold font type.

 

Hyphens and Dashes

Compound words frequently take a hyphen. Use a hyphen (-) to form a modifier with two or more words (six-figure salary).

 

Its vs. It's

"Its" is the possessive of the neuter pronoun. "It's" is the contraction for "It is."

 

Lists

Bulleted lists
If you have a bulleted list, all sub-lists under that list are also bulleted lists (not numbered lists).

Numbered Lists
If you have a numbered list, all sub-lists under that list are also numbered lists (not bulleted lists).

 

Month

When a month is used with a specific date, abbreviate only:

  • Jan.
  • Feb.
  • Aug.
  • Sept.
  • Oct.
  • Nov.
  • and Dec.

Spell out when using alone, or with a year alone.

 

Numbers

  • Spell out numbers from one through nine; use numerals from 10 up. Be consistent within a series or a list.
  • Use commas between every group of three digits in numbers of 1,000 or more (1,200). Do not use a comma between dates referenced simply as month and year (February 2004).

 

Phone Numbers

AP style favors hyphens not parentheses. For example, 603-646-1110.

 

Plurals

  • Do not use an apostrophe to form the plural (IBMs).
  • Do not form a plural with an apostrophe. Use "s" or "es." An exception is for single letters, for clarity (Mary earned straight A's).

 

Possessives

Use the apostrophe and "s" in all singular possessives and only the apostrophe in plurals.

 

Program Titles and Documents

Program titles and documents are in italic.

 

Punctuation

  • Treat an ellipsis (the omission of words) as a three-letter word with a character space on both sides.
  • Quotation marks should be outside of a comma or period, and inside other punctuation marks, unless the punctuation mark is part of the material being quoted.

 

Seasons

Are lowercase, except when in a title (Winter Carnival).

 

Symbols

Avoid using them except in scientific usage or tabular matter.

 

Time

Written as hour:minute a.m. or p.m. If it is the top of the hour, you do not need the :00. Use a.m. or p.m. (with periods). Use noon and midnight rather than 12 a.m. or 12 p.m.

 

Titles

Do not capitalize a title unless it immediately precedes the person's name.

Print Article

Details

Article ID: 158440
Created
Mon 10/23/23 3:53 PM
Modified
Mon 1/8/24 9:37 AM