CLIP LearnDocs 1.0
For trainers

Learner materials

Curate what appears in every learner's Library — add official CGI and CLIP materials as external links or read-in-app pages, then publish or hold as a draft.

The Materials page is where you decide what shows in every learner's Library. A material is either a link out to something you host elsewhere, or a page you write directly in CLIP for learners to read in the app. You choose the shelf it sits on, the type of resource it is, and whether it goes live now or waits as a draft.

Where to find it

Materials lives at /faculty/materials and is reached from the Teaching menu in the top navigation, labelled Materials. Only Faculty and Admin users can open it.

Not the Media library

This page is distinct from the Media library (at /faculty/library), which is for uploading files. Materials curates the entries in the learner-facing Library — links and read-in-app pages — rather than raw file uploads.

Two shelves

Every material sits on one of two shelves, chosen with the Shelf field. Learners see the shelf as a heading in their Library.

ShelfValueUse it for
Official · CGIOFFICIAL_CGIMaterials that are part of, or issued by, the official CGI Foundation qualification.
Supporting · CLIPCLIPCLIP's own explainers, revision aids and supporting content. This is the default.

Adding a material

Fill in the New material form at the top of the page. Only a title and something for the learner to open are required; everything else is optional.

Title. A short name for the material, e.g. Directors' duties — quick guide. Required, up to 200 characters.
Description (optional). One line describing what the material is. Up to 1,000 characters. Shown under the title in the list.
Shelf. Pick Supporting · CLIP (default) or Official · CGI — see the table above.
Type. What kind of resource this is: Companion / explainer, Textbook, Handbook, Orientation, Revision sheet, Worksheet, Recording, or Exam Q&A. Defaults to Companion / explainer.
Course (optional). Scope the material to a single course, or leave it as All courses to show it to everyone.
Syllabus ref (optional). A short reference such as F2.3. Up to 24 characters. Shown alongside the type in the list.
Provide the content. Give the learner one of two things to open (see below): an External link, or a Read-in-app Markdown page. If you supply neither, the material is not saved.
Tags (optional). Comma-separated keywords, e.g. directors, duties. They are lower-cased, and up to 12 are kept.
Publish or hold. Leave Publish to learners now ticked to make it live immediately, or untick it to save the material as a draft that no learner can see yet. Then press Add material.

Each material gives the learner exactly one thing to open, and you choose which:

OptionFieldWhat the learner gets
External linkExternal link — an https://… URLThe material opens externally, in a new tab, at the URL you gave.
Read-in-app pageRead-in-app content — MarkdownThe material opens inside CLIP's in-app reader. Write it in Markdown (up to 16,000 characters).

You must provide one of the two

A material needs either a link or read-in-app content — with neither, the form does nothing and no material is created. If you fill in both, the read-in-app content is what learners open.

Managing existing materials

Below the form, saved materials are grouped under their shelf — Official · CGI first, then Supporting · CLIP. Each row shows the title, a status badge, the type and any syllabus ref, and an icon indicating whether it is a read-in-app page or an external link. Each row has these controls:

ControlWhat it does
PreviewOpens the material as a learner would see it — the in-app reader for read-in-app pages, or the external URL for links. Opens in a new tab.
Publish / UnpublishToggles whether learners can see the material. Unpublish archives a live material; Publish makes a draft or archived one live.
Delete (bin icon)Removes the material from every learner's Library. You are asked to confirm first — this cannot be undone.

Statuses

A material's badge reflects its state:

StatusMeaning
PublishedLive and visible to the relevant learners.
DraftSaved but hidden from learners — created when you untick Publish to learners now.
ArchivedWas live, now withdrawn via Unpublish. Hidden from learners, but kept so you can re-publish it.

Learners' own study aids are never here

This page only lists materials you author for the tenant. Study aids that learners generate for themselves are never shown, edited, published, or deleted here — the publish/unpublish and delete actions are blocked for anything a learner created. Curating materials never touches a learner's own work.

On this page