Note outline

From Lumeniki
Jump to: navigation, search

A note outline is a lumenati invention designed to be the easiest way to create an infinitely organizable outline for notes.

Attributes of note outlines[edit]

Note outlines have the following attributes:

  • The top headings of the outline are indicated with a hyphen/minus symbol (-) at the beginning of the line. This lets the reader know that any line that is not indented, is not a top level heading unless it begins with the minus symbol.
  • Subheadings are made with one space for each level of the subheading, much like any outline.
  • Text editors should be set to replace each tab with a space and indent only one space per tab. This can be done in Windows with Notepad++ or Metapad. In Linux it can be done with Gedit or Kate. These text editors are also able to tab-in (select and press tab) or tab-out (shift tab) entire sections at a time. They allow you to drag and drop selections. These features enable you to quickly move sections and reorder headings anywhere you choose.
  • Collapsing is possible with JEdit, if sections become too large (see "Collapsing note outlines" below). Otherwise you have to move things to new documents so sections are not too large .
  • Depends on word wrap to keep lines from running out to the right of the visible window.
  • Only basic (ASCII?) characters. No "smart quotes", special formatting, etc.
  • No numbering or lettering is used for the outline headings because this requires too much effort and they would have to be redone if any part of the outline is reordered, unless perhaps software is found that creates these numbers auto-magically, but the other purpose is so that the outline is readable on the most basic devices, such as a tiny, "cheap" MP4 player.

Examples of note outlines[edit]

These are some examples of note outlines that Lumenos posted in this wiki, however Lumenos doesn't always use the minus "-" for top-level headings; ey often omits them if not many of the lines are long enough to wrap to the next line:

Software considerations[edit]

MediaWiki markup[edit]

Displaying note outlines in MediaWiki[edit]

You may notice if you post a note outline in MediaWiki, it is not displayed properly. You may also notice from the given examples, the "poem" tag can be used to make it display properly.

DavidCary's comments (rearranged by Lumenos)[edit]

There are dozens of allegedly "simple" formats to mark up text so that (1) the text is relatively human-readable on a low-end plain text reader, and (2) the text can be interpreted as having headings, sub-headings, etc. Describing any of these formats in a wiki (rather than in a plain text file) is a little tricky.

In MediaWiki you can make a note outline display properly by putting the
tags around it (see examples).

How do I make MediaWiki display my text just like it does in the edit box or in a text file? Three ways:

  • slap a "<poem>" tag at the beginning, a "</poem>" tag at the end.
  • slap a "<pre>" tag at the beginning, a "</pre>" tag at the end. MediaWiki makes a big dotted line box around all the preformatted text.
  • slap "<source lang="text">" tag at the beginning, a "</source>" tag at the end.


Perhaps we can show this in MediaWiki like this:


- top-level heading
some text
    subheading
        sub-subheading
some text
.
.
        sub-subheading
    subheading
some text


- top-level heading

some text

.... subheading

........ sub-subheading

some text . .

........ sub-subheading

.... subheading

some text


- top-level heading
some text
    subheading
        sub-subheading
some text
.
.
        sub-subheading
    subheading
some text



- top-level heading
some text
    subheading
        sub-subheading
some text
.
.
        sub-subheading
    subheading
some text

Further reading[edit]


Lumenos replies[edit]

Much thanks to DavidCary for posting an example of using the "poem" tag. Lumenos 07:13, June 4, 2010 (UTC)

I think the poem tag requires a specific extension to be installed. ~ Lumenos (talk) 19:15, May 26, 2012 (EDT)

Collapsing note outlines[edit]

For long note outlines it can be useful to hide text, for example, to make only the first level headings visible, or make all the first and second level headings visible. JEdit (jEdit) is a Java text editor that can do this. It makes the outline navigational like the folder tree you see, if you right-click a folder and click "Explore", in Windows. You can expand or collapse any level with the click of the mouse.

Other outlines and note storage techniques and locations[edit]

Lumenos also uses various wikis running MediaWiki, to make "outlines" (ie the table of contents) for publicly viewable notes. Other public notes are stored in internet forums.