> For the complete documentation index, see [llms.txt](https://synap.ac/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://synap.ac/docs/platform/library/notes.md).

# Notes

Notes are pages of learning content authored directly in Synap. They can combine formatted text, media, files, equations and embedded content in one reusable Library item.

{% hint style="info" %}
**Location:** Library → Create or upload → Note
{% endhint %}

### When to use a note

Use a note for explanations, reading material, instructions or supporting content that should be edited directly in Synap. A note can be added to a course or collection and reused wherever that content is needed.

### Build a note

The note builder has four areas:

| Area             | Purpose                                                                                  |
| ---------------- | ---------------------------------------------------------------------------------------- |
| **Note details** | Set the title, short description, full description, owner, collaborators and attributes. |
| **Content**      | Author and format the page users will read.                                              |
| **Settings**     | Configure additional behaviour available for the note.                                   |
| **Access**       | Control who can access and manage the note.                                              |

Use **Preview** while editing to check the user-facing result, particularly after adding tables, media or conditional content.

### Format content with the editor

The What You See Is What You Get (WYSIWYG) editor provides the following groups of tools:

| Tools                   | Available options                                                                                            |
| ----------------------- | ------------------------------------------------------------------------------------------------------------ |
| **Text structure**      | Paragraphs, headings, font family, font size and alignment.                                                  |
| **Emphasis and colour** | Bold, italic, underline, strikethrough, remove formatting, font colour and background highlight.             |
| **Inline content**      | Links, subscript, superscript and special characters.                                                        |
| **Blocks and lists**    | Block quotes, horizontal lines, bulleted lists, numbered lists and tables.                                   |
| **Media and files**     | Images, file attachments, Portable Document Format (PDF) embeds and HyperText Markup Language (HTML) embeds. |
| **Technical content**   | Code blocks, MathType, ChemType and text-part language.                                                      |
| **Personalisation**     | Variables and Logic, where enabled for the portal.                                                           |

![The Note content editor and its formatting, media, Variables and Logic controls](https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWXE6hvHQFtER1a1Dm3l5%2Fuploads%2Fso4hkjYdh23EmsNtnb8m%2Fnote-editor.png?alt=media\&token=ef675afc-b52d-409a-ab71-86f4ded7a3ce)

Structure a note using headings rather than styling ordinary paragraphs to look like headings. This improves navigation, accessibility and consistency across devices.

{% hint style="info" %}
Use tables for genuinely tabular information. For a simple sequence or collection of points, a numbered or bulleted list is usually easier to read on smaller screens.
{% endhint %}

### Dynamic Variables and Logic

**Variables** can insert contextual values, such as information about the current user or portal, when the note is displayed. **Logic** can conditionally show content when its rules are met.

This makes it possible to personalise a shared note without maintaining separate copies. Because the rendered result can vary by user, preview and test each important branch before publishing. Dynamic content will be covered in more detail in its own Product Reference section.

### Before sharing a note

1. Use a clear title and short description.
2. Check heading order and link text.
3. Add alternative text to meaningful images.
4. Preview embedded media, files, variables and logic.
5. Confirm access before adding the note to a course, collection or assignment.

{% hint style="info" %}
Keep a note focused on one topic. Shorter, well-titled notes are easier to reuse than large pages that combine unrelated material.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://synap.ac/docs/platform/library/notes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
