Published by epsilon.my.noteshare.io
Guides, Tutorials, Handbook
tutorials
- Tutorials
handbook
- Comprehensive information
mathematics
- Mathematics
- Other
Buttons
Menu bar
Go to the Noteshare home page. |
|
Go to your home page. |
|
Go to previous site |
Home page
New notebook. |
|
Manage your groups |
|
Help, info |
Editor Buttons
New section: text or attach PDF |
|
Notebook settings |
|
Export notebook (as download) |
|
Edit or re-order table of contents |
|
Explain what each button does |
Comment |
|
Delete section |
|
Section tags, summary, other settings |
|
Upload image |
|
Edit |
Collapse or expand the table of contents |
|
View pdf file in browser |
Check section in/out |
|
Forbid/Allow inclusion |
|
Publish/unpublish section (1) |
|
Publish/unpublish document (2) |
|
Share current section |
(1,2) Green if published, otherwise unpublished (private)
exporting a notebook
- Downloading an archive
-
See this Noteshare blog article for more details.
checking a section in our out
- Check-in, checkout
-
If you are part of a group, your collaborators can still read this section, but they can’t edit it until you check it back in. When you check out a section, the button turns red. If you press it when it is red, it turns blue — you have checked it back in.
including part of a section in another
- Inclusion
-
See the Noteshare newswletter article on Snippets for more information.
Menus
Standard |
three-column view with table of contents |
Simple |
a view with out the editing tools |
Source |
source text on left, rendered text on right |
Sec/print |
a printable view of the current section |
Whole doc |
a printable view of the whole document |
LaTeX |
convert the current section to LaTeX (experimental) |
keyboards shortcuts
Keyboard shortcuts
ctrl = Control Key
alt = Alt or Option Key
ctrl-B — Browse
ctrl-R — Read
ctrl-W — Write
ctrl-M — Media
ctrl-P — Print — show printable version of page
ctrl-N — New section
ctrl-E — Edit current section
ctrl-A — Edit aside for current section
ctrl-U — Update: save source text and refresh rendered text
ctrk-Y — "Yoke:" scroll source and rendered text together
crtl-I — Scroll source and rendered text independently
ctrl-X — Exit editor without saving
search
Searching Noteshare
- Barebones searching
-
Put a single word in the search box at the top of the page. Noteshare will match it to the titles and tags (keywords) of all the public notebooks on the site, plus those you or members of your group have written. If you didn’t find what you were looking for, try putting the code s: in front of your search terms. Read the next item might explain why this helps.
- Search by section
-
Put s: atom in the search box to find sections of documents having to do with atoms.
- Search by author
-
Put a: beta123 in the search box to find articles by the user with screen name beta123.
- Searching inside a notebook
-
As your notebooks get bigger, it gets harder to find things inside them. Fortunately you can search inside a notebook. Here is how you wold sarch for atoms: Type i: atoms. Likewise, to search for potatoes, you woud type i: potatoes. You can put more than one keyword in your search — Noteshare will look for sections of your notebook that coontain all the keywords that you type/ Just remember — to search inside, type i: first.
- Search for images and other media
-
Type m: bird to search the media database for the keyword "bird". We found one that we particularly like. It has ID number 460, and we inserted it like this:
IMAGE::460[width=250, float=right]
- Searching for your own work
-
Sometines — often — you want to search your own library of notebooks. Where on earth is my report on chromium bromate, or my poem "Ode to laziness"? Well, use the option --mine. The search chem --mine will give a list of your notebooks in which the word "chem" appears (in the title, tags, or description). The search m: bird --mine will find your bird photos and no others. Importantly, s: atom --mine retrieves a list of sections of your notebooks that match. And if you really can’t find it, try the full text search t: atom --mine.
- Search by domain
-
Use d: lit to search for notebooks in the subdomains containing lit, e.g., lit.noteshare.io, literature.noteshare.io, etc.
- Full text search
-
The search t: atom will give you a list of sections of notebooks in which the word "atom" appears anywhere in the text. Because this is a full text search, it is slower, but wiill find more than, say, a search by section (s: and ms:) . Often it will find too much.
cross references
Cross References
For now I am just going to record some info on cross-referneces to other sections while it is fresh in my mind.
- Link to the heading of another section
-
Let’s make a link to the section on searching in his notebook. Go to that section now and look at the ower right-hand corner of the screen. You will see hte umbers 395:1610. The second is the one we are looking for. It is the ID number of the section, It is like your Social Security number. No two people have the same Social Security Number, and no two sections, even in different notebooks have the smae ID numbers. There are enough for everybody. To refer to the section in question, you type this:
XLINK::1610[How To Search].
And this is what you get:
- Link to a specific part inside another section
-
Let’s make a cross-reference to the part about searching inside a notebook Here is what you write:
XLINK::1610#searching-inside[How To Search Inside a Notebook].
And this is what you get:
It seems like magic, but there is a trick. In the section on searching, we wrote this:
[#searching-inside] Searching inside a notebook
You did not see the text
[#searching-inside]
, but is is there. It is a kind of label that Noteshare can use to find things.[1] that finds them. Asciidoctor is the text processing engine that makes Noteshare what it is.] When you are wriing something, you can put labels like this wherever you want. There is more to making and using labels, but this is enough for now.
Compiling/exporting your notebook
Compiling your notebook means assembling it into single, possibly very long web page. Kind of like a book, or a scroll. Here is one example.
To compile,
first edit your Notebook Setttings using the tool.
The settings should include
the [doc.header]
section like the one below — author’s name, date, and, optionally, two strings which
determine whether document is numbered, whether it
has a table of contents, and (optionally) the ID of the
title page image.
You should also have a [doc.options]
section that includes
one of these lines:
compile-sections=all compile-sections=public compile-sections=none
There are other options settings, but this is the one relevant to compiling your notebook. See notebook settings for more information. Notice that the options and the header sections have different formats.
[doc.header] -- Jeremy Foobar 11-20-2014 :numbered: :toc2: :titlepage-image: 194 -- [doc.options] -- compile-sections=public --
Notebook settings
To change the settings of a notebook, click on . Settings are optional, but they affect the notebook’s appearance and behavior. Below is an example, and below the example are notes on what the various settings do.
Each group of settings is optional and independent
of the others. For example, you may have a [doc.header]
section but none of the others. The [doc.texmacros]
section
is for those who use
Asciidoctor-LaTeX.
If a section contains more than one paragraph, fence it off
with --
as in the case of [doc.texmacros]
. The
[doc.header]
section should always consist of a single
paragraph.
[doc.header] Phineas Fogg November, 1803 :toc2: :numbered: :titlepage-image: 816 [doc.options] compile-sections=all essays.noteshare.io=can-publish [doc.description] A concise guide to getting started with Noteshare. [doc.texmacros] -- \def\AA{\mathbb{A}} \def\BB{\mathbb{B}} \newcommand{\set}[1]{ \{\,#1\, \} } \def\dim{\mathop{dim}} --
- [doc.header]
-
-
The first two lines should contain the author’s name and the date
-
:toc2:
— place the table of contents on the side in the compiled version. -
:numbered:
: — number sections automatically, -
:titlepage-image: 816
— use the image with ID 816 for the title page of the notebook.
-
- [doc.options]
-
-
compile-sections=all
— include all sections when compiling a notebook. You can also saycompile-sections=public
orcompile-sections=none
. in the compiled version.The compiled version is what you get when you choose Show Doc from the View menu.
-
essays.noteshare.io=can-publish
— Permit cross-publication of your notebook byessays.noteshare.io
. -
show-source=yes
— Allow others to view source and rendered text side by side (without the ability to edit the source).
-
- [doc.description]
-
Set the text which appears as the "blurb" in the right-hand column of the title page.
Asciidoctor-LaTeX
The main reference is the Asciidoctor-LaTeX Manual.
- Macro definitions
-
Put macro defnitions in the attributes field of your notebook to make them accessible to all sections. Press NA to view or modify the notebook attributes field. Then imitate this example:
[doc.texmacros] -- \def\AA{\mathbb{A}} \def\BB{\mathbb{B}} --
Macro definitions can also be placed directly in a document as follows
[env:texmacro] -- \def\AA{\mathbb{A}} \def\BB{\mathbb{B}} --
Note the "s" in the first construct — The tex macros for the document versus the texmacro environment.
- Cross references (equations)
-
If you label an equation like this,
[env.equation#pyth]
then you you can refer to it like this
<<pyth>>
to get a hyperlink reference that looks like (12). If, on the other hand, you label it like[env.equation#eq-pyth]
then the reference
<<eq-pyth>>
will be a hyperlink like Equation 12.
Customizing your home page
To customize your home page, select Edit site from the menu. Then edit the text in the "Customize site" box. That text consists of three possible sections:
-
Settings
-
Right-hand content
-
Right-hand links
These are illustrated below. If you need more than one paragraph in a section, fence it off with a pair of -- marks, as illustrated under "Content". The Customize site box can be empty or can contain one or more of the three sections discussed below.
The customized home page is the version the public sees, e.g., epsilon.my.noteshare.io/public. You can see this version by selecting Public from your home menu: .
[site.settings] display_rh_links=yes display_rh_content=yes rh_link_heading=Links
[site.rh_content] -- !!IMAGE::681[align=center] ## Images OK here _Nautilus shell_ ## Markup OK also The Nautilus is an amazing creature --
[site.rh_links] Hacker News::https://news.ycombinator.com/
Managing groups
add user fred55 delete user fred55 set owner fred55 -- only for admin add notebook 5 delete notebook 5 edit notebook 4 readable=true edit notebook 4 commentable=true add notebook 5 readable=true writeable=true
Index
-
Groups
-
Home page
-
menu
-
references