Authoring With Course Cafe
By Administrator
First published on April 26, 2019. Last updated on June 16, 2024.
Authoring With Course Cafe
By Administrator
First published on April 26, 2019. Last updated on June 16, 2024.
Table of Contents
- Preface for Instructors and Authors
- 1 Getting Started
- 1.1 Creating Your First Course
- 1.2 Changing the Order of Lessons in a Course
- 1.3 Content Entry Fields and Buttons
- 2 Universal Design and Accessibility
- 3 Special Content Types
- 3.1 Images and Videos
- 3.2 Files
- 3.3 Tables
- 3.4 Color-Shaded Boxes
- 3.5 Alert Messages
- 3.6 Short Codes
- 3.7 Hidden Text
- 3.8 Mathematics
- 3.9 Computer Code
- 3.10 Quizzes
- 3.11 Embedding Other Content
- 3.12 Optimizing For Print or Display
- 4 Advanced Styling Tools and Techniques
- 5 Special Topics
- 6 Editors
- 7 Administrators
- Appendix: Text Editor Quicktags and Codes
This manual describes how to author with Course Cafe. Authoring with Course Cafe is similar to composing in a word processor such as Microsoft Word. In fact, much of the time it will be simpler. You will just type and use a few tools. However, there some differences and and added complexity concerning how to build a course with multiple lessons and to publish it in multiple forms.
Course Cafe is built upon WordPress. There are many online general training tutorial for WordPress if you want more information than this site’s documentation provides. However, even if you already know how to use WordPress, you should still read this site’s instructions, because significant additions and changes and been made.
This manual describes how to author with Course Cafe. Authoring with Course Cafe is similar to composing in a word processor such as Microsoft Word. In fact, much of the time it will be simpler. You will just type and use a few tools. However, there some differences and and added complexity concerning how to build a course with multiple lessons and to publish it in multiple forms.
Course Cafe is built upon WordPress. There are many online general training tutorial for WordPress if you want more information than this site’s documentation provides. However, even if you already know how to use WordPress, you should still read this site’s instructions, because significant additions and changes and been made.
-
Preface for Instructors and Authors
First published on May 11, 2019. Last updated on May 11, 2019.
Authoring With Course Cafe is intended as a tutorial, guide and reference for instructors and authors who create content on Course.Cafe.
An introduction regarding how to create a course and lesson is provided. These provide the basic skills to create content on the platform. If you just type text, for example for a law or literature course, this might be all that you need.
If you already know WordPress, then much will be familiar. Although Course.Cafe is focused upon creating textbooks, it is also possible to create posts and allow commenting. For those who are unfamiliar with WordPress, a description of the editing fields is provided.
However, there is much that has been added beyond standard WordPress, and some that is entirely new. Much of the rest of this authoring course discusses how to handle special content such as formulas.
As an educator or authors, it is expected that accessibility will be important. How to improve accessibility as well as principles of universal design are discussed, and additional resources are listed.
-
1 Getting Started
First published on . Last updated on May 11, 2019.
We will get started with learning how to Author on Course.Cafe with a brief introduction how to create a course and lesson. Of course you can create many courses and attach many lessons to each course, once you know how to set up one of each. Then a description of the editing fields will explain things further.
-
1.1 Creating Your First Course
First published on April 30, 2019. Last updated on August 24, 2024.
Instructions for creating a course with lessons
- Go to Dashboard. On the left hand side menu, hover over over Courses and click on Add New.
- You should be taken to a new page to enter your course. Under the Edit Course label, enter the course title and and desired content.
- Then in the upper right hand corner, click Save Draft. (You can save as often as you wish). To make the course publicly available, click Publish.
- On the left hand side menu, hover over over Lessons and click on Add New.
- Add the Lesson title.
- Enter some content into the large field in your Lesson’s entry view, below the Add Media button and text editing tools.
- If you want to attach your lesson to a course, choose the course name in the Related Course list.
- Then, in the upper right hand corner, click Save Draft. However, the lesson will not appear on the course page until you click Publish.
- On the left hand side menu, hover over over Courses and click on All Courses.
- When you see a list of courses, then hover just under your course’s title and click on the Edit link.
- You can preview your courses or lessons at any time.
- To view the course as a student or other reader, click on the link to the right of “Permalink:” beneath the title.
Editing your a course and lessons
As a Course Cafe author, you can go back and edit your courses and lessons at any time. Just go to the Course list or Lessons list, and click Edit beneath the content item title. Remember save your work by clicking the relevant button, which might be Save Draft, Update, or Publish, all in the upper right hand corner in the Publish pane.
Suggestion: first create a list of your planned lessons. The create the lessons in reverse order of the order for them to be read. They will then appear in your desired order for readers. If you ever need to change the order, please contact the Course Cafe administrator.
Caveat: if you change your course title, you will need to change it in each of the lessons for that course.
Backing Up Your Contents
You should periodically back-up your course by periodically generating a PDF of your course. This is accomplished by clicking the Print book for this course button on the course page. Back-ups are made of the entire Course Cafe site, the the availability of such back-ups cannot be guaranteed.
Setting up course navigation and searchability
You can go ahead and create a course on your own. Linked titles for all of the lessons for the course should appear on the course page. However, once a reader is in a lesson, there may be additional set-up required for the links to and previous and next lesson to work as desired. The first step is to contact the administrator to set up a category for your course. It could have the same title as your course. However, it does not have to have the same title, but it should be different from any existing category.
Once the category is set up, then select it for any lesson that you wish to appear in the footer navigation. However, do not select a category if you wish to omit it from footer navigation. For example, you might wish to have break-out lessons for students who need extra practice or background, but which would not be appropriate for all of your students.
Accessibility
To maximize the impact of your content, you should make it accessible to a range of users with diverse abilities, backgrounds and devices. Further, some organizations require content to be accessible per various standards. For further information, see Accessibility and Universal Design.
-
1.2 Changing the Order of Lessons in a Course
First published on July 20, 2019. Last updated on July 20, 2019.
To change the order of lessons in a book:
1. go to Lessons in the left hand menu.
2. Choose the name of the desired related course.
3. Click the Filter button.
4. Drag lessons in the desired order.
Filter then drag lessons to re-order them for a course
Warning: you can drag lessons in an unfiltered list, but the changed order will not show up in the course order.
-
1.3 Content Entry Fields and Buttons
First published on April 30, 2019. Last updated on May 11, 2019.
(Excerpts below taken from WordPress.org.)
Title/Headline Box
The title of your post. You can use any phrases, words or characters. Avoid using the same title twice as that will cause problems. You can use commas, apostrophes, quotes, hyphens/dashes and other typical symbols in the post like “My Site – Here’s Lookin’ at You, Kid”. WordPress will then clean it up to generate a user-friendly and URL-valid name of the post (also called the “post slug”) to compose the permalink for the post.
Body Copy Box
The blank box where you enter your writing, links, links to images, and any information you want to display on your site. You can use either the Visual or the Text view to compose your posts. For more on the Text view, see the section below, Visual Versus Text View.
Preview button
Allows you to view the post before officially publishing it.
Publish box
Contains buttons that control the state of your post. The main states are Published, Pending Review and Draft. A Published status means the post has been published live on your blog for all to see. Pending Review means the draft is waiting for review by an editor prior to publication. Draft means the post has not been published and remains a draft for you. If you select a specific publish status and click the update post or “Publish” button, that status is applied to the post. For example, to save a post in the Pending Review status, select Pending Review from the Publish Status drop-down box, and click Save As Pending. To schedule a post for publication on a future time or date, click “Edit” in the Publish area next to the words “Publish immediately”. You can also change the publish date to a date in the past to back-date posts. Change the settings to the desired time and date. You must also hit the “Publish” button when you have completed the post to publish at the desired time and date.
Publish box
Visibility – This determines how your post appears to the world. Public posts will be visible by all website visitors once published. Password Protected posts are published to all, but visitors must know the password to view the post content. Private posts are visible only to you (and to other editors or admins within your site)
Save
Allows you to save your post as a draft / pending review rather than immediately publishing it. To return to your drafts later, visit Posts – Edit in the menu bar, then select your post from the list.
Publish
Publishes your post on the site. You can edit the time when the post is published by clicking the Edit link above the “Publish” button and specifying the time you want the post to be published. By default, at the time the post is first auto-saved, that will be the date and time of the post within the database.
-
2 Universal Design and Accessibility
First published on . Last updated on May 16, 2019.
Good design tends to be accessible by a diverse a range of users, including users with visual and other impairments. This approach is called Universal Design. Further, many schools and organizations require materials to be accessible by all students. While this page won’t cover everything, it will provide some suggestions to improve accessibility.
Color and Contrast
Some students are color blind. They can’t differentiate between reds and greens. So avoid pure red or green, or make the colored content clearly differentiable. For example, instead of using red and green check marks, you could wither use blue or orange ones, or use a different symbol for each case.
Some students can’t read low contrast content. For example, black lettering upon a dark blue background might not be readable. So make certain to include a sufficiently high contrast.
Image Alternative Text
The visually-impaired often cannot perceive images. This can be somewhat mitigated by including a description in the Alt Text field for the media (see the metadata fields for media items in the Media Library). Alt Text should not merely repeat the caption. It should add descriptive information for those who cannot see the image. For example, the alt text for a volcano could be “pointed mountain with smoke puffing out of top”.
Captioning
To help audio-impaired persons, videos should ideally be captioned. There are several services who will do this as well as software that allows you to enter such. An alternative that might be sometimes acceptable is to provide a transcript of the video that includes some description of visual elements.
Captioning can also be very helpful to readers whose primary language is different than that of the speakers in the video, or to those accustomed to a different accent.
Interactive Content
Interactive content, such as embedded or linked Javascript applets, can be a challenge for the impaired to fully use, and often don’t even work in all platforms for any users. You should provide an alternative for interactive content just in case it won’t work for some users.
Responsive Design & Mobile Devices
These days, people view content on numerous types of devices and platforms, from giant monitors to tiny smart phone screens. It can be a challenge to create content that works well with all of the possibilities. This is called responsive design. Steps can be taken to improve responsiveness.
Course.Cafe itself has been tested on various platforms, and has been designed to be somewhat responsive. The layout is designed to display differently on large versus small screens. However, there is still work to do. Course.Cafe will strive to further improve responsiveness.
However, the biggest challenges that you as an author may encounter is that some embedded content itself is not responsive. You can sometimes improve responsiveness through the following measures:
- if an image, try setting a smaller image size.
- if a video, try a different video window size.
- sometimes scroll bars can be turned on for special content
- iframe (shortcode) can sometimes give you control over embedded media that can’t be obtained otherwise.
Also, obviously some content will not display well (or at all) in a PDF (especially when read offline), or when the PDF is printed on traditional paper. Please see Optimizing For Print or Display to improve content for PDF and print responsiveness.
Further Reading
- Universal design (Wikipedia)
- Web Content Accessibility Guidelines (WCAG)
- How to Write Alt Text and Image Descriptions for the visually impaired (Perkins)
- Image ALT Text includes examples of how to write Alt Text(Pennsylvania State University)
-
3 Special Content Types
First published on . Last updated on August 24, 2024.
There are many special content types that you can include in Course Cafe lessons. (It may be possible to embed them in course descriptions as well, but doing so might be distracting from the natural flow of viewing the course or book.) Types include images, videos, files, tables and several other types. Several of these types will be covered in the following sections..
-
3.1 Images and Videos
First published on May 11, 2019. Last updated on May 16, 2019.
Images
You can often just copy and paste images into your Course.Cafe content. However, the preferred way is to first click on the Add Media button and upload the image into the Media Library, then insert it into your content. Make sure to enter the metadata including Alt Text to improve accessibility. You should enter the source and copyright information into the Description field.
GIF, JPEG (JPG) and PNG image files work best. Some other types might not work or might not display on older computers or browsers.
You can often choose a size for the image in its edit menu after you add it to a course or lesson. If none of the sizes is what you want, choose the smallest image size that is larger than your desired size, then decrease that size to what you desire. (You can drag to resize.) Decreasing the size of a larger image will improve image display quality.
Videos
Use the same approach for videos as for images. You might need to manually add your own caption in the content field rather than in metadata. There is no Alt Text field for videos, but ideally there should be captioning.
- TIP! To avoid videos appearing in the print version of your course, embed videos in the following short codes: [iframe class="noprint" src="your source"]] and [[/iframe]. The “scr” refers to the URL of the video, and “class” tells the video not to appear in the print version (which would show up as a blank space).
MP4 videos files are best to use. Other types might not appear on all browsers.
-
3.2 Files
First published on . Last updated on May 11, 2019.
Sometimes you will want to upload files for readers to download, such as a text document, spreadsheet, etc.
Sometimes Course.Cafe might reject your file. Sometimes this is to avoid security risks. Many documents can contain malware. Compressing these files into a ZIP file makes them both easier to download and safer.
- If just one file, then zip (compress) that file.
- If multiple files, place the files in a folder, then zip (compress) the folder.
- Upload the zip file.
-
3.3 Tables
First published on . Last updated on May 11, 2019.