File: formatting.rst

package info (click to toggle)
eln 1.5.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,876 kB
  • sloc: cpp: 26,606; perl: 796; python: 437; sh: 73; makefile: 32; xml: 8
file content (92 lines) | stat: -rw-r--r-- 3,118 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
Formatting
==================

Inline with its mission, NotedELN only allows the most basic of
formatting options.

Standard typography
-------------------

*Italics*
    Press [Ctrl][I] or [Ctrl][/] to italicize the word under the cursor
    or the current selection (or to unitalicize).
  
**Bold face**
  
    Press [Ctrl][B] or [Ctrl][\*] (or [Ctrl][8]) for bold face.
  
_Underline_
  
    Press [Ctrl][U] or [Ctrl][_] (underscore; on my keyboard:
    [Ctrl][Shift][-]) for underline.
  
:sub:`Sub`\ scripts and :sup:`super`\ scripts
  
    Press [Ctrl][^] (or [Ctrl][6]) to create a superscript and
    [Ctrl][-] (minus) to create a subscript. Superscripts and
    subscripts can also be created by typing [^] or [_] followed by
    the text of the superscript or subscript and then pressing
    [Ctrl][.] (period).

.. _crossout:    

Editorializing: Highlighting and crossing out
---------------------------------------------

Any text, old or new, can be highlighted using the |highlight| icon
([F7]) or crossed out using the |strikeout| icon ([F8]). These
annotations can be removed using the |plain| icon ([F9]). Highlighting
of the selection or word under the cursor can also be toggled using
[Ctrl][!] (or [Ctrl][1]). Likewise, [Ctrl][=] toggles cross-out.


.. |highlight| image:: highlight.png
              :height: 3ex
              :class: no-scaled-link

.. |strikeout| image:: strikeout.png
              :height: 3ex
              :class: no-scaled-link
                      
.. |plain| image:: plain.png
              :height: 3ex
              :class: no-scaled-link


Footnotes
---------

Press [Ctrl][N] to create a footnote. Footnotes are connected to the
main text by arbitrary tags: the word at the cursor becomes the
tag. If you prefer to use symbols to tag footnotes, the symbols \*, †,
‡, §, ¶, and ♯ can be created by typing \*, +, ++, $, @, and # before
pressing [Ctrl][N]. Footnotes are deleted by deleting the tag in the
main text or by pressing [Ctrl][Shift][N] while the tag is
highlighted.

If your tag is a big integer, it is interpreted as a PubMed ID. In
that case, NotedELN will insert the corresponding citation in the note
for you automatically. (If you have suggestions for other kinds of
automatically created note contents, I want to hear from you.)


Indentation
-----------

By default, the first paragraph of a note is not indented, whereas
subsequent paragraphs are. To change the indentation of a paragraph,
press [Shift][Tab]. Repeat to cycle through the options:

- No indent
- Normal indent
- Reverse (“hanging”) indent

Typesetting quotations, computer code, and other imported materials
----------------------------------------------------------------------

Occasionally it is useful to typeset “imported” materials such as
quotations differently from the rest of your notes. In a small
concession to typographic nicety, NotedELN does this for you if you
press [Ctrl][Tab]. The paragraph will be typeset in a slightly
different color, a slightly smaller point size, and with slightly
larger margins. To revert, simply press [Ctrl][Tab] again.