Skip to content
This repository was archived by the owner on Mar 11, 2021. It is now read-only.

Revised Help Center Files #453

Open
julia-s-123 wants to merge 53 commits into
base: master
Choose a base branch
from
Open

Revised Help Center Files #453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
77506d8
Add files via upload
julia-s-123 Nov 7, 2017
875e5fb
Update annotate_documents.md
julia-s-123 Nov 8, 2017
6ed6a76
Update collaboration.md
julia-s-123 Nov 8, 2017
db1d04f
Update collaboration.md
julia-s-123 Nov 8, 2017
4a9f79f
Update collaboration.md
julia-s-123 Nov 8, 2017
f94a5d9
Update collaboration.md
julia-s-123 Nov 8, 2017
c945f4d
Update document_modification.md
julia-s-123 Nov 8, 2017
fd06d94
Update api.md
julia-s-123 Nov 10, 2017
4e8c64f
Update collaboration.md
julia-s-123 Nov 10, 2017
d7b2a81
Update document_modification.md
julia-s-123 Nov 10, 2017
04f789d
Update document_modification.md
julia-s-123 Nov 10, 2017
8fc1b3f
Update managing_accounts.md
julia-s-123 Nov 10, 2017
790d068
Update privacy.md
julia-s-123 Nov 10, 2017
2324c2c
Update publishing_embedding.md
julia-s-123 Nov 10, 2017
910e379
Update publishing_embedding.md
julia-s-123 Nov 10, 2017
807930e
Add files via upload
julia-s-123 Nov 10, 2017
8873e20
Update publishing_embedding.md
julia-s-123 Nov 10, 2017
7b5c5f1
Update publishing_embedding.md
julia-s-123 Nov 10, 2017
6b01374
Update publishing_embedding.md
julia-s-123 Nov 11, 2017
16f6703
Update publishing_embedding.md
julia-s-123 Nov 11, 2017
c624ebb
Update publishing_embedding.md
julia-s-123 Nov 11, 2017
f98f181
Update publishing_embedding.md
julia-s-123 Nov 11, 2017
be3fe4f
Add files via upload
julia-s-123 Nov 11, 2017
ec381a2
Update publishing_embedding.md
julia-s-123 Nov 11, 2017
10e55ab
Update search_documents.md
julia-s-123 Nov 11, 2017
d2db1bd
Update troubleshooting.md
julia-s-123 Nov 11, 2017
451df30
Update uploading_documents.md
julia-s-123 Nov 11, 2017
97c9684
Update annotate_documents.md
julia-s-123 Nov 11, 2017
d960c6a
Update publishing_embedding.md
julia-s-123 Nov 11, 2017
3594d02
Update publishing_embedding.md
julia-s-123 Nov 11, 2017
68c149d
Update document_modification.md
julia-s-123 Nov 11, 2017
d70b2d9
Update adding_sections.md
julia-s-123 Nov 14, 2017
ebf28ef
Update annotate_documents.md
julia-s-123 Nov 14, 2017
a97fc52
Update annotate_documents.md
julia-s-123 Nov 14, 2017
f76c861
Update collaboration.md
julia-s-123 Nov 14, 2017
df40729
Update collaboration.md
julia-s-123 Nov 14, 2017
9c2761c
Update document_modification.md
julia-s-123 Nov 14, 2017
202fb3b
Update guided_tour.md
julia-s-123 Nov 14, 2017
374bf0f
Update guided_tour.md
julia-s-123 Nov 14, 2017
92ad672
Add files via upload
julia-s-123 Nov 14, 2017
1087396
Update managing_accounts.md
julia-s-123 Nov 14, 2017
fa9fa07
Update managing_accounts.md
julia-s-123 Nov 14, 2017
58ff8a2
Update privacy.md
julia-s-123 Nov 14, 2017
6e9d08b
Update publishing_embedding.md
julia-s-123 Nov 14, 2017
4550105
Update publishing_embedding.md
julia-s-123 Nov 14, 2017
5d4b82e
Update search_documents.md
julia-s-123 Nov 14, 2017
74bc1b0
Update search_documents.md
julia-s-123 Nov 14, 2017
ed57f9c
Update search_documents.md
julia-s-123 Nov 14, 2017
81a47fa
Update search_documents.md
julia-s-123 Nov 14, 2017
797656d
Update troubleshooting.md
julia-s-123 Nov 14, 2017
7500b9d
Update troubleshooting.md
julia-s-123 Nov 14, 2017
79298a0
Update uploading_documents.md
julia-s-123 Nov 14, 2017
567de28
Update uploading_documents.md
julia-s-123 Nov 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions app/views/help/help_center_drafts/files/adding_sections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@


# Adding Sections for Navigation
To help differentiate portions of a long document, you can add **navigation links** to the sidebar by **defining sections.**

#### To Add Sections to a Document:

1. Locate **“Document Tools”** on the right-hand sidebar of the document workspace.
2. Select **"Edit Sections"**.

![Edit Sections](../images/adding_sections/editsections.png)

3. In the dialog box, input the **title** for each section you want to create, as well as the starting **page number** for that section.
4. Use the **plus and minus icons** to add and remove rows.
![Adding and Removing Sections](../images/adding_sections/adding_sections1.gif)
5. Select **"Save"**.
6. Your sections will appear in the **left-hand sidebar**, as below. Simply click on the name of the section you want to navigate to.

![Sections Final](../images/adding_sections/sections.png)

102 changes: 102 additions & 0 deletions app/views/help/help_center_drafts/files/annotate_documents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Annotate Documents: Public, Private, and Draft Notes


DocumentCloud supports both private and public notes. **Public notes** are visible to anyone who has access to the document. **Private notes** are only ever visible to their author.

Public notes may also be saved as **drafts**. Draft notes are visible to anyone with the privileges necessary to annotate a document, including reviewers and collaborators, but they won't be published with the document.


**In this article:**
* Add a note to a specific section of a page
* Add a note to an entire page
* Link to a specific note you've made
* Print your notes
* Delete your notes
* Add markup to notes

## How to Annotate Documents

#### Add a Note to a Specific Section of a Page

1. Locate **“Document Tools”** on the right-hand sidebar of the document workspace.
2. Select **“Add a Public Note”** or **“Add a Private Note”**.

![Adding notes sidebar](../images/annotate_documents/publicnote.png)
3. When you mouse over pages in your document, your cursor will change into crosshairs. **Click and drag** over the area of the document you want to annotate.

![Clicking and dragging notes](../images/annotate_documents/annotate_documents1.gif)
4. Title and add commentary to the note as you wish.

#### Add a Note to an Entire Page

1. Select **“Add a Public Note”** or **“Add a Private Note”**.
2. When you mouse in between two pages of your document, you will see a **dotted line**. Click to add a full-page annotation tagged to the lower page.

![Full-page annotations](../images/annotate_documents/annotate_documents2.gif)

Once you add notes to your document, **all notes and their titles will appear in the sidebar** as below. **Click** the title of a note anywhere in your document to open it.

![Clicking through notes](../images/annotate_documents/notesidebar.png)

## Linking to Notes
When sharing a document with others, you can **link directly to specific notes you have made** instead of the document as a whole. To do this, you must create a permalink for the note in question.

#### To Create a Note Permalink:

1. Open a note.
2. Click the **link icon** located beside the note title.

![Note permalinks](../images/annotate_documents/annotate_documents3.png)
3. **Your browser's address bar will be updated to display the full URL of the annotation.**
* The good stuff comes after the # symbol — in our example the URL of the embedded document ends with #document/p173/a8646, so we know that the annotation is on page 173.
4. **Copy the url** and share.

NOTE: You also can embed a note directly. See our [publishing and embedding documentation](publishing_embedding.md) for details.

## Printing Notes
It's easy to print out all the notes on a particular document or collection of documents.

#### To Print Notes:

1. Navigate to the **"Your Documents"** page.
2. Select the documents you want to print. A blue line should appear around the document icon(s).
3. Select **"Publish"**. Select **"Print Notes"** from the dropdown.

![Printing notes](../images/annotate_documents/annotate_documents4)
4. Use your **browser or system dialog** to print.

## Deleting Notes

#### To Delete a Note:

1. **Open the note** by clicking on it.
2. Select the **pencil icon** at the top of the note to ender edit mode.
3. Select the **"Delete"** button to remove the note.

![Deleting notes](../images/annotate_documents/annotate_documents5.gif)

NOTE: Deleting a note cannot be undone, so proceed with caution.

## Advanced

#### Markup and HTML in Notes

Note bodies can contain a limited subset of HTML and attributes. **The table below lists some commonly used elements and attributes.** You can find a full list beneath the table.

| | | |
|-----------------|--------------------------------------------------------------------------------------|--------------------------------------------|
| ELEMENT | DESCRIPTION | ATTRIBUTES |
| `<a>` | creates a hyperlink | href |
| `<img>` | displays an image | src, width, height, alt, align |
| `<br/>` | inserts a line break | – |
| `<em>, <i>` | emphasizes/italicizes text | – |
| `<strong>, <b>` | bolds text | – |
| `<u>` | underlines text | – |
| `<blockquote>` | offsets text as a quote | – |
| `<table>` | creates a table into which rows (tr elements) are inserted | summary, width |
| `<tr>` | creates a table row to hold table data (td elements) and table headers (th elements) | – |
| `<th>` | creates a table header cell | abbr, axis, colspan, rowspan, width, scope |
| `<td>` | creates a table cell in a "tr"" row | abbr, axis, colspan, rowspan, width |
| `<ol>` | creates a numbered ordered list | start, reversed, type |
| `<ul>` | creates is a bulleted unordered list | type |
| `<iframe>` | An iframe can be used to embed web pages. | src, srcdoc, width, height, sandbox |
Loading