Skip to content

Latest commit

 

History

History
106 lines (66 loc) · 4.73 KB

Enclst.md

File metadata and controls

106 lines (66 loc) · 4.73 KB
Raw

Enclst Notation

The Enclst Notation consists of Title string and ItemList separated by a blank line, fx:

Plant Encyclopedias, this is the title of this Enclst

https://www.bhg.com/gardening/plant-dictionary/ | Plant Encyclopedia
https://www.plantsnap.com/plant-encyclopedia/ | Plant Encyclopedia: Complete Online Plant and Flower ...
https://www.picturethisai.com/wiki | Online Plant Encyclopedia and Common Popular Plants

The first line is the Title of this Enclist which is separated from the remaining ItemList by a blank line at second line.

Each part is defined as follows:

  • Title
    A single line string that is terminated by a new line code like the first line.

  • Blank line
    A blank line like line 2 which has only line feed. The Encyclolist application recognizes the lines after this blank line as itemlist.

  • ItemList
    Multiple strings where one line represents one item.

Illustrated below:

Title

The Title is a single line string terminated by a new line code.

If multiple lines exist before the first blank line, only the first line will be recognized as the title.

Plant Encyclopedias, this is the title of this Enclst
This line is not title, just be ignored
This lie is also not title

https://www.bhg.com/gardening/plant-dictionary/ | Plant Encyclopedia
https://www.plantsnap.com/plant-encyclopedia/ | Plant Encyclopedia: Complete Online Plant and Flower ...
https://www.picturethisai.com/wiki | Online Plant Encyclopedia and Common Popular Plants

Note that the current version of the Encyclolist application ignores the rest of the lines, but future versions may interpret those lines to have some special meaning. Anyway, currently only the first line is recognized as the title

Item List

The item list is lines of items each line consists of the URL, a vertical bar | and item title as follows:

https://www.bhg.com/gardening/plant-dictionary/ | Plant Encyclopedia

The Encyclolist application use the above URL as a bookmark link and item title as a line title.

More precisely, the Encyclolist application recognizes the first vertical bar delimited forward as the URL and the rest as the item title. So even if the item title string itself contains | , they are treated as part of the title normally.

https://www.bhg.com/gardening/plant-dictionary/ | ItemTitle |no problem|

FYI | is not a character that can be used in URLs so there is no real case where it appears in URLs. But in case you put | inside your URL, The Encyclolist application miss-recognizes the first half of the string separated by | as the URL.

The Encyclolist application simply discards lines that cannot be recognized as item. More precisely if there is no |, this line just be ignored.

Special case

Blank first line

In case the first line is blank, the Encyclolist application recognizes that this enclst has blank title whcih consist of only brank character. If you want to omit the title, start with a blank line like this.


https://www.bhg.com/gardening/plant-dictionary/ | Plant Encyclopedia
https://www.plantsnap.com/plant-encyclopedia/ | Plant Encyclopedia: Complete Online Plant and Flower ...
https://www.picturethisai.com/wiki | Online Plant Encyclopedia and Common Popular Plants

Last line blank

Blank lines at the end of sentences are ignored.

https://www.bhg.com/gardening/plant-dictionary/ | Plant Encyclopedia
https://www.plantsnap.com/plant-encyclopedia/ | Plant Encyclopedia: Complete Online Plant and Flower ...
https://www.picturethisai.com/wiki | Online Plant Encyclopedia and Common Popular Plants

No blank line

In case there are no blank lines, the expected Encyclolist application behaviour is undefined.

The application strives to guess if the first line is the title line or the first line of Item list. It's reasonable to hope that future versions of the application will be smart enough.　But the earlier version of the application might recognize that the first line is the title and this ecnlst has blank ItemList that has no item. It may not be probable the result you wanted, you forgot to start with a blank line to omit the title.

Several blank lines

In case there are several blank lines, The Encyclolist application recognizes as title of the first line and as ItemList as remaining. Also, the Encyclolist application simply discards lines that cannot be recognized as items. As a result, these multi-blank line enclst is recognized as the same as normal single blank line enclst

Plant Encyclopedias

https://www.bhg.com/gardening/plant-dictionary/ | Plant Encyclopedia

https://www.plantsnap.com/plant-encyclopedia/ | Plant Encyclopedia: