footnote:[This is just a test of the amazing capabilities of http://asciidoctor.org[Asciidoctor]
Scripta User Guide
Scripta has a variety of writing tools, from word counts to indexes.
- Word count
The word count of the current chunk of your document is displayed in the footer of the document as you edit.
To make a footnote,. like the one in this sentence, insert the text
- Commenting out
Sometimes you may wish to leave text in the source that is not visible in the rendered version. For a single line, do this:
// This section needs to be revised.
For more than one line, you may do this;
//// This article needs a much clearer outline. Please call Ms. Grundy, the staff editor, as soon as possible. ////
To make a cross-reference to another part of the text, enclose the ID for that part of the text in double angle brackets:
You can make your on ID’s, or you can use Scripta’s auto-generated ID’s. For example, consider this section, Writing tools. The ID
_writing_tools_is automatically generated, so we can insert the text
to make a cross-reference. It will appear as an active link to the Writing tools section,
- Across blocks
In Scripta, a "master" document consists of one or more blocks. Imagine blocks of text that when laid end-to-end make up your document. In this document, Asciidoc 101, Teaching Tools, and Writing Tools are blocks. Note the little square before the block name.
To reference another block, use the code
as a model. Here 787 is the ID of the block in question. The ID of the document being edited is displayed in the right part of the editor tool bar.
As an example, we make the link Teaching Tools to the previous section using this code:
xlink ::1492[Teaching Tools]
- Across blocks to a specific item
You can also link to a specific item inside a block. Consider, for example, the subsection History Questions in the section Teaching Tools. The link
refers to the History Questions item. Here is the code:
xlink ::1492#_history_questions[Making History Questions]
You can mark terms for a per-section glossary like this:
In this case, the word potrezebie would be inserted in the glossary that you will find at the end of this section. In the main text, you would find potrezebie set in a dark red color. Look to see if you find any glossary terms on this page. Glossary terms link to their entry in the glossary list and vice versa.
You may also mark a glossary term like this:
In this case, the phrase "imaginary contraption" appears in the glossary as explanatory text for the term "potrezebie." (We do note, by the way, that there was a time in the previous millennium in which the term potrezebie appeared in certain forms of humorous litereature).
To instruct Noteshare to display the glossary, put the code
:glosssary: somewhere in the section — the beginning and
the end are good choices. The glossary will appear at the
end of the section. Thus, in the present section, the
glossary appears at the
end of the last subsection — subsection "[last_section]" — take a look at it now.
|See Writing Tools for a long example of a glossary.|
Building an Index
Suppose you are writing a text about animals:
The Aardvark is a strange animal with an equally strange name ...
To add "Aardvark" to the index, change your text to this:
( ( (Aardvark) ) ) The Aardvark is a strange animal with an equally strange name …
The index works only in the compiled view. Also, in order to instruct Scripta to make the index, you must add the code
to your document preferences. To edit your document preferences, click on the triple-gear icon .
To cite an entry in the bibliography, follow this model:
_The Cyberiad_ <<cyb>>, reviewed in <<cyb2>>, recounts the adventures of
Note that the citations, following the usual syntax for cross-references, consist of a label enclosed in double angle brackets. The bibliography itself begins as in the following excerpt. Note that the bibliographical labels are enclosed in triple brackets/
[bibliography] - [[[cyb]]] Lem, Stanisław (1975). The Cyberiad – fables for the cybernetic age. translated by Michael Kandel. United Kingdom: Secker and Warburg. ISBN 0436244209
Below are the rendered bibliographical citation and bibliography.
[cyb2] The Cyberiad: Fables for the Cybernetic Age / Stanislaw Lem. reviewed by Tal Cohen, Wednesday, 01 April 1998.
Below is the glossary automatically constructed from the marked-up text.