User Tools



Notes

Notes are a Project-level feature that supports sharing information and status with others on your team. The content you create here is persisted and searchable. Navigating to the Notes tab from any Space will show the Notes Summary view for the parent Project.

Note: A single Notes collection is shared by all Spaces in a Project.

  1. Use these tabs to switch to view either active or archived Notes.
  2. You can search for Notes containing the text you enter here.
  3. Clicking on the star icon here toggles a filter that shows either only starred Notes or all Notes.
  4. If a Note has a To-Do list, the number of outstanding (unchecked) To-Do items is shown here.
  5. If a Note has been assigned an owner, the owner's name is shown here.
  6. Clicking on the star icon toggles the importance of the Note between normal (no star) and important (starred).
  7. Note titles are displayed as clickable links, with the Note title comprising the link text.
  8. If a Note has one or more files attached, this icon is shown along with the count of file attachments.
  9. If a Note has comments attached, this icon is shown along with the count of comments.
  10. Clicking this icon will archive the Note, making it appear in archived Notes view.

New Note

There are two ways to create a new Note.

  • Directly from the Note summary view
  • Implicitly from a specific result set.

Create a Note Directly

To create a Note directly, navigate to the Notes view, available in the Project or Space main view.

Click on the New Note button in the upper right of the view.

This brings up the New Note dialog shown below.

  1. The Note title goes here. This is the text that will comprise the link text in the Notes view.
  2. Here you can optionally assign a Note owner. This is useful when the Note has follow-up items (such as to-dos) and you want to make one person responsible for completion. The owner is displayed with the note in the Note view and is automatically subscribed to the Note.
  3. These tabs allow you to toggle between input markup text (Markdown format) and the rendered version.
  4. Editor toolbar. Hovering over each button will show a tooltip describing its function.
  5. Clicking here will display the editable note text in a full-screen mode. This is useful for Notes with lots of text.
  6. The note text goes here. The text is written in Markdown format with a custom extension to support to-do check boxes.
  7. Click and drag this thumb to resize the text box.
  8. Clicking here allows you to attach one or more files of any type to the note. These files will appear in the Note as clickable links.
  9. Users selected here will receive an email notification when the note is submitted and when any comments are added to the note in the future. The creator of the Note and the owner (if any) are automatically subscribed.

Note From a Result Set

Often, you want to share information related to a specific result set with other members of your team. For example, there may be some test failures or other anomalies that need to be addressed.

As a convenience, you can create a Note implicitly from a result set.

To create such a Note, navigate to the Space results view and click on the hamburger menu at the right end of the result's row. Select Comment from the menu.


To-Do List

The Notes editor implements a custom extension to Markdown that's used to create ToDo check boxes.

Custom Markdown Extension

When creating or editing a Note, you can enter the check box markdown yourself, or use the Editor Toolbar button labeled To-Do to automatically insert the text.

Shown below is the markup text and how it is rendered in the Note.

Markup

Rendered

Changing Check State

Typically, when you create a Note with To-Do items, you create the list with all items open (unchecked). The task owner will then change the state of each item to checked once completed.

When viewing the Note, anyone can toggle the state of a To-Do check box by simply clicking on the check box.

Only the creator of the Note can edit the list.


Projects


Page Tools