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}}\)

6. Creating notes and notebooks

In this section we learn how to create a new note, edit it, and save it.

Open a new tab in your browser, and open the NoteShare handbook in the new tab.

creating a note
editing a note
ERROR: refs[refid] was nil
ERROR: refs[refid] was nil
creating a notebook

6.1. Creating a Note

Screenshot 2015 05 25 05.57.36
  • Click on "New" in the upper left of this page (see image on right). This will take you to a new window where you will see two "panes", one pinkish, the other yellowish. The pinkish one is where you type in new text.

  • Type "== Second Note" at the very top of the pinkish (source) window. You have just set the title for the note.

  • Skip down a few lines and write something.

  • Press the blue "update" button (bottom of screen), or type control-U. You should see your "rendered" text in the right-hand pane.

  • Finally, press the blue "exit" button. With this button you exit the editor. Pushing this button does NOT save your work.

6.2. Editing a Note

  • Click the "edit" link in the upper left of the screen.

  • You are now in the editor.

    • The "source" text is on the left in the yellowish window pane, the "rendered" text is on the right, in the blueish window pane

    • Start typing in the "source text" like you would in an email. Paragraphs start right at the left margin and are separated by blank lines.

    • Click the blue "update" button (bottom), or type control-U to update the rendered text and save the source text.

    • Click the blue "exit" button to go back from where you came, or type control-X.

    • Warning: Pressing exit does not save your work.

  • Soon you will have the hang of it.

6.3. Markup 102

You have probably noticed some funny little symbols in the source text. Those are "markup" codes. They affect the structure and presentation of the content that you write. For example, here is some bold text. And here is some italic text. We wrote them this way in the source window: *bold text* _italic text_

To learn how markup works, use reverse-engineering: compare the source and rendered text. Do this by choosing Source in the View menu. You will see the source text and rendered text in side-by-side windows.

There are many markup languages. We are using asciidoc markup. It can be read by both humans (us!) and by computers. We create the content and the computer uses the Asciidoctor program to translate our content into web pages, a pdf file, or an electronic book With markup, what an author writes can be published in many formats without additional work.

Our motto: Write once, use many.

  • Advantages of markup. You can create good-looking, well structured documents more quickly and with better focus than with a WYSIWYG editor. You keep you eyes on what you are typing, and your mind on the text you are creating — no breaks in thought to find the mouse or the menu item to click, no struggles with formatting.

  • Disadvantages of markup. You have to learn a few new things, as you do with any tool. The good news: most writing requires a small subset of Asciidoctor’s versatile and powerful toolset.

In this Handbook, we concentrate on the basics of Asciidoc markup, If you find you need more than is in the Handbook, please consult the documentation at asciidoctor.org.

6.3.1. Markup Shortlist

You can do a great deal of writing with just little markup. Below is a short list of markup codes.

  1. Use *...* for bold text.

  2. Use _..._ for italic text.

  3. Put a dot at the left margin, then a space, then your text for a numbered list item. Look at the source for this text to see what I mean. (Click on Source in the View menu).

  4. Use an asterisk (*) instead of a space for bulleted lists.

  5. Use == TITLE for the title of your note. This text should go at the very top of the source at the left margin.

  6. Use === SUBTITLE for subtitles.

  7. Put the code :numbered: in your text to automatically number sections, subsections, etc. Everything after this code will be numbered. Say :!numbered: to turn off automatic numbering.

See how far you can get with these seven pieces of markup code!

6.4. Creating a notebook

  1. Click on *Home*in the menu bar.

  2. Click on New Notebook — right-hand column below Tools & Resources.

Created June 6, 2014, last updated: August 21, 2015