Title page | James Carlson

Collapse Share Open book
  • 2.1 Create a notebookhttp://www.noteshare.io/section/asciidoc-101?part=Create%20a%20notebook#_create_a_notebook
  • 2.2 Create a new sectionhttp://www.noteshare.io/section/asciidoc-101?part=Create%20a%20new%20section#_create_a_new_section
  • 2.3 Imageshttp://www.noteshare.io/section/asciidoc-101?part=Images#_images
  • 2.4 Manage notebookhttp://www.noteshare.io/section/asciidoc-101?part=Manage%20notebook#_manage_notebook
  • 2.5 Collaborationhttp://www.noteshare.io/section/asciidoc-101?part=Collaboration#_collaboration
  • 2.6 Exporthttp://www.noteshare.io/section/asciidoc-101?part=Export#_export
  • 3.1 First things firsthttp://www.noteshare.io/section/markup-basics?part=First%20things%20first#_first_things_first
  • 3.2 Sectionshttp://www.noteshare.io/section/markup-basics?part=Sections#_sections
  • 3.3 Blockshttp://www.noteshare.io/section/markup-basics?part=Blocks#_blocks
  • 3.4 Basic tableshttp://www.noteshare.io/section/markup-basics?part=Basic%20tables#_basic_tables
  • 4.5 Math Homeworkhttp://www.noteshare.io/section/math-homework?part=Math%20Homework#_math_homework
  • 4.6 Chemistryhttp://www.noteshare.io/section/math-homework?part=Chemistry#_chemistry
  • 5.1 Browse menubarhttp://www.noteshare.io/section/the-menus--to-revise-and-update-?part=Browse%20menubar#_browse_menubar
  • 5.2 Read menubarhttp://www.noteshare.io/section/the-menus--to-revise-and-update-?part=Read%20menubar#_read_menubar
  • 5.3 Write menubarhttp://www.noteshare.io/section/the-menus--to-revise-and-update-?part=Write%20menubar#_write_menubar
  • 5.4 Media menubarhttp://www.noteshare.io/section/the-menus--to-revise-and-update-?part=Media%20menubar#_media_menubar
  • 6.1 Creating a Notehttp://www.noteshare.io/section/creating-notes-and-notebooks?part=Creating%20a%20Note#_creating_a_note
  • 6.2 Editing a Notehttp://www.noteshare.io/section/creating-notes-and-notebooks?part=Editing%20a%20Note#_editing_a_note
  • 6.3 Markup 102http://www.noteshare.io/section/creating-notes-and-notebooks?part=Markup%20102#_markup
  • 6.4 Creating a notebookhttp://www.noteshare.io/section/creating-notes-and-notebooks?part=Creating%20a%20notebook#_creating_a_notebook
  • 7.1 A simple tablehttp://www.noteshare.io/section/tables-?part=A%20simple%20table#_a_simple_table
  • 7.2 A formatted tablehttp://www.noteshare.io/section/tables-?part=A%20formatted%20table#_a_formatted_table
  • 7.3 A table with a headerhttp://www.noteshare.io/section/tables-?part=A%20table%20with%20a%20header#_a_table_with_a_header
  • 7.4 A table with a header and footerhttp://www.noteshare.io/section/tables-?part=A%20table%20with%20a%20header%20and%20footer#_a_table_with_a_header_and_footer
  • 8.1 References within a notehttp://www.noteshare.io/section/cross-references-2?part=References%20within%20a%20note#_references_within_a_note
  • 8.2 References within Notesharehttp://www.noteshare.io/section/cross-references-2?part=References%20within%20Noteshare#_references_within_noteshare
  • 8.3 References to a web pagehttp://www.noteshare.io/section/cross-references-2?part=References%20to%20a%20web%20page#_references_to_a_web_page
  • 8.4 References to something inside a web pagehttp://www.noteshare.io/section/cross-references-2?part=References%20to%20something%20inside%20a%20web%20page#_references_to_something_inside_a_web_page
  • 9.1 Syntaxhttp://www.noteshare.io/section/mathematical-notation?part=Syntax#_syntax
  • 10.1 Exampleshttp://www.noteshare.io/section/chemistry?part=Examples#_examples
  • 10.2 Structural formulashttp://www.noteshare.io/section/chemistry?part=Structural%20formulas#_structural_formulas
  • 10.3 Referenceshttp://www.noteshare.io/section/chemistry?part=References#_references
  • 14.1 Check-in and check-outhttp://www.noteshare.io/section/collaboration?part=Check-in%20and%20check-out#_check_in_and_check_out
  • 14.4 Authorship of commentshttp://www.noteshare.io/section/comments?part=Authorship%20of%20comments#_authorship_of_comments
  • 15.1 Attributeshttp://www.noteshare.io/section/extras?part=Attributes#_attributes
  • 16.1 Notes on the embed featurehttp://www.noteshare.io/section/test-of-embed-feature?part=Notes%20on%20the%20embed%20feature#_notes_on_the_embed_feature
  • 17.1 Standard accounthttp://www.noteshare.io/section/noteshare-advanced-features?part=Standard%20account#_standard_account
  • 17.2 Premium accounthttp://www.noteshare.io/section/noteshare-advanced-features?part=Premium%20account#_premium_account
  • 17.3 In the pipelinehttp://www.noteshare.io/section/noteshare-advanced-features?part=In%20the%20pipeline#_in_the_pipeline
  • 20.1 Problem sets, etc.http://www.noteshare.io/section/technical-appendix?part=Problem%20sets,%20etc.#_problem_sets_etc
  • 20.2 Quiz #1http://www.noteshare.io/section/technical-appendix?part=Quiz%20#1#_quiz
  • 20.3 Quiz #2http://www.noteshare.io/section/technical-appendix?part=Quiz%20#2#_quiz
  • 20.4 Technical notehttp://www.noteshare.io/section/technical-appendix?part=Technical%20note#_technical_note
  • 21.1 The Quadratic Equationhttp://www.noteshare.io/section/linking-the-main-page-and-the-aside?part=The%20Quadratic%20Equation#_the_quadratic_equation
  • 21.2 The Cubic equationhttp://www.noteshare.io/section/linking-the-main-page-and-the-aside?part=The%20Cubic%20equation#_the_cubic_equation
  • 22.1 Why Markup?http://www.noteshare.io/section/asciidoc-markup?part=Why%20Markup?#_why_markup
  • 22.2 PDFhttp://www.noteshare.io/section/asciidoc-markup?part=PDF#_pdf
  • 22.3 Links between lessonshttp://www.noteshare.io/section/asciidoc-markup?part=Links%20between%20lessons#_links_between_lessons
  • 22.4 More Asciidoc Exampleshttp://www.noteshare.io/section/asciidoc-markup?part=More%20Asciidoc%20Examples#_more_asciidoc_examples

Noteshare Handbook

\(\def\AA{\mathbb{A}} \def\BB{\mathbb{B}} \def\CC{\mathbb{C}} \def\DD{\mathbb{D}} \def\EE{\mathbb{E}} \def\FF{\mathbb{F}} \def\NN{\mathbb{N}} \def\OO\mathbb{{O}} \def\PP{\mathbb{P}} \def\QQ{\mathbb{Q}} \def\RR{\mathbb{R}} \def\ZZ{\mathbb{Z}} \def\ffp{\mathfrak{p}} \def\bold#1{\bf #1} \def\CCC{\mathcal{C}} \def\EEE{\mathcal{E}} \def\FFF{\mathcal{F}} \def\PPP{\mathcal{P}} \def\UUU{\mathcal{U}}    \newcommand{\commadots}{, \ldots, } \newcommand{\set}[1]{ \{\,#1\, \} } \newcommand{\sett}[2]{ \{\,#1\, \mid\, #2\, \} } \newcommand{\Set}[1]{ \Big\{\,#1\, \Big\} } \newcommand{\Sett}[2]{ \Big\{\,#1\, \Big\vert\; #2\, \Big\} } \newcommand{\mapright}[1]{\ \smash{ \mathop{\longrightarrow}\limits^{#1}}\ } \newcommand{\vars}[2]{{#1}_1\commadots{#1}_{#2}} \newcommand{\map}{\longrightarrow} \def\rank{\mathop{rank}} \def\dim{\mathop{dim}} \def\height{\mathop{height}}\)

2. Working with notebooks

Screen Shot 2015 08 21 at 11.19.16 AM
Figure 1. Editing Panel

This section describes how to use the tools for creating, editing, and managing notebooks. If you click on the title of one of the notebooks listed on your home page, you will be led to a page which displays the editor control panel. It should look roughly like the control panel in Figure 1. For a short description of what a button does, mouse over it. For a longer description, click on the help tool question.

In what follows, we group the buttons by function — creating a notebook, creating a section, adding an image, etc. The first two are essential, while the remaining ones can be studied at your leisure.

2.1. Create a notebook

To create a notebook and edit its first section, you will need to know how to use just four buttons.


Go the home page and click on new_document to create a document. Fill out the form and press Create. You will be led a page with the controls as displayed in the figure elow.


The controls for editing a document are displayed in Figure 1 above. Click on edit to edit the current section.


If you are editing text for the current section, click on Screen_Shot_2015-08-21_at_8.39.38_AM to update and save it. The key command Ctrl-U has the same effect.


Click on Screen_Shot_2015-08-21_at_8.42.01_AM to exit the editor window without saving. The key command Ctrl-X has the same effect.

2.2. Create a new section

To create a new section of a notebook, then publish or share it, use the buttons listed below.

Screen Shot 2015 08 21 at 11.19.16 AM
New section

Click on new and fill out the form. In the form there is a check box labeled "Attach PDF". Check it if you want to upload a PDF file, and then follow directoins.


Click on publish to make the current section public. Click on it again to make it private. If the section is public, the background is green. Anyone can view a public section. Cllick on unlock to make all sections of the current notebook public. Click on it again to make all sections private.


Click on share to share a section with someone by email.

Mouse over a button in the Editing Panel to view a short description of what it does.

2.3. Images

Upload image

Click on image to upload an image. Fill out the form, choose the image, then press Upload. When the upload is complete, note the ID of the image. For instance, if the ID is 632, you can place an image in your document with image ::632[] or image ::632[width=200].

For audio, use the same button but write the link as audio ::632[]. For video it is best to link to YouTube or vimeo. See Adding Video in this manual.

2.4. Manage notebook

Tags, Summary

Click on tag to edit the section summary or its search tags.

Change title

Click on gears to change the title of a notebook or to edit its search tags.

Change order of sections

Click on toc to change the order of the section of a notebook.

Delete section

Click on trash to delete a section. This operation cannot be undone. You will be asked to confirm your choice.

2.5. Collaboration


If the author of a document allows comments on it, the comment tool comment will be displayed. Click on it to add a comment. The comment must be of the form


To ensure that your comment will be posted, do not modify the text upon which you comment. Your user name and the date will be included with the comment.


Click on checkout to check a section out. Click it again to check the section back in. When a section is checked out, only the person to whom it is checked out can edit it. This feature is useful for collaborative writing and editing projects.

Make includable:

When a section is "includable", part or all of a section may be included in another document. Click on toggle_inclusion to permit inclusion. Click it again to forbid inclusion. A section that is includable displays hte include tool with a light green background. See the May, 2015 newsletter to see how this feature works.

2.6. Export


Click on download to export an entire notebook. See the June, 2015 Newsletter for details on how this is done and for a description of what the download includes.

Created August 21, 2015, last updated: September 16, 2015