branch: externals/org-remark
commit bb6d48c61c815b4eaf015a66ed8954fbe84281af
Author: Noboru Ota <m...@nobiot.com>
Commit: Noboru Ota <m...@nobiot.com>
docs: Update screen shots and README
---
README.org | 24 ++++++++++-----
demo/demo.txt | 7 +++--
demo/marginalia.org | 44 +++++++++++++++++++++++++++
resources/images/2022-01-22-Context-menu.png | Bin 0 -> 472559 bytes
resources/images/2022-01-22-Title.png | Bin 0 -> 390053 bytes
resources/images/2022-01-22-code.png | Bin 0 -> 261120 bytes
6 files changed, 64 insertions(+), 11 deletions(-)
diff --git a/README.org b/README.org
index 8c20391adb..8322419e68 100644
--- a/README.org
+++ b/README.org
@@ -33,7 +33,7 @@ For customization, refer to the customization group
`org-transclusion' or user m
* Screenshots :noexport:
-[[./resources/images/2020-12-24T101116_Title.png]]
+[[./resources/images/2022-01-22-Title.png]]
*Figure 1*. Left: Org-mode with text enlarged; Right marginal notes with the
inline image display on
Refer to the screenshots below for a teaser of what it can do.
@@ -42,14 +42,11 @@ Refer to the screenshots below for a teaser of what it can
do.
The screen shots are from the old Org-marginalia. They are still relevant but
new screen shots are on their way.
#+end_quote
-[[./resources/images/2020-12-22T141331-OM-screen-shot-01.png]]
-*Figure 2*. Left: main note with some text highlighted in green; Right:
marginal notes in a marginalia file
+[[./resources/images/2022-01-22-Context-menu.png]]
+*Figure 2*. Mouse context menu with built-in ~context-menu-mode~ available
with Emacs version 28 onwards
-[[./resources/images/2021-08-17T220032.png]]
-*Figure 3*. Left: ~org-roam-buffer~ showing backlinks from the marginal notes;
Right: main Org note. Org-remark can automatically add links with Org-ID from
marginal notes back to the main file. This works well with Org-roam's backlinks
-
-[[./resources/images/2020-12-22T141331-OM-screen-shot-03.png]]
-*Figure 4*. Main note can be any text files. Left: an ~.el~ file with a
highlight; Right: marginal notes file
+[[./resources/images/2022-01-22-code.png]]
+*Figure 3*. Main note can be any text files. Left: marginal notes file; Right:
an ~org-remark.el~ file with a highlight.
* Installation
:PROPERTIES:
@@ -119,3 +116,14 @@ This work is licensed under a GPLv3 license. For a full
copy of the licese, refe
:PROPERTIES:
:org-remark-file: ~/src/org-remark/org-remark.el
:END:
+
+** (defmacro org-remark-create
+:PROPERTIES:
+:org-remark-beg: 4027
+:org-remark-end: 4000
+:org-remark-id: c759f435
+:org-remark-label: nil
+:org-remark-link: [[file:~/src/org-remark/org-remark.el::120]]
+:END:
+
+This macro was inspired by
[[https://github.com/jkitchin/ov-highlight][Ov-highlight]]. It's by John
Kitchin (author of Org-ref). Great UX for markers with hydra. Saves the marker
info and comments directly within the Org file as Base64 encoded string. It
uses overlays with using ~ov~ package.
diff --git a/demo/demo.txt b/demo/demo.txt
index 443f2879aa..e296d96b98 100644
--- a/demo/demo.txt
+++ b/demo/demo.txt
@@ -1,7 +1,8 @@
- *Org-marginalia*
+ *Org-remark*
Highlight text;
- write marginalia for any
- text file.
+ annotate for any text file.
+ † Name chagned from
+ Org-marginalia
diff --git a/demo/marginalia.org b/demo/marginalia.org
index 7fc2f481c6..7be90a79ca 100644
--- a/demo/marginalia.org
+++ b/demo/marginalia.org
@@ -44,3 +44,47 @@ Marginalia from Opticks or, A treatise of the reflexions,
refractions, inflexion
:marginalia-source-end: 317
:END:
[[file:~/local-repos/org-marginalia/demo/marginalia.org][marginalia]]
+
+* demo
+:PROPERTIES:
+:org-remark-file: ~/src/org-remark/demo/demo.txt
+:END:
+
+** Marginalia
+:PROPERTIES:
+:org-remark-beg: 99
+:org-remark-end: 113
+:org-remark-id: 76539dd9
+:org-remark-label: nil
+:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::8]]
+:END:
+
+*** Pronunciation
+(General American) IPA(key): /mɑɹdʒɪˈneɪli.ə/
+(Received Pronunciation) IPA(key): /mɑːdʒɪˈneɪli.ə/
+Rhymes: -eɪliə
+Hyphenation: mar‧gi‧na‧lia
+
+*** Etymology
+From New Latin marginālia, from Medieval Latin neuter plural of marginālis
(“on the periphery”), from Latin margō (“border, edge”). Compare margin.
+[[file:Marginalia_from_Opticks_or,_A_treatise_of_the_reflexions,_refractions,_inflexions_and_colours_of_light.png]]
+Marginalia from Opticks or, A treatise of the reflexions, refractions,
inflexions and colours of light, is lincensed under CC BY 2.0. Obtained via
https://en.wiktionary.org/wiki/marginalia
+
+** any text file
+:PROPERTIES:
+:org-remark-beg: 54
+:org-remark-end: 67
+:org-remark-id: 6a4de876
+:org-remark-label: yellow
+:CATEGORY: important
+:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::5]]
+:END:
+
+** Highlight
+:PROPERTIES:
+:org-remark-beg: 21
+:org-remark-end: 31
+:org-remark-id: 4d94d0fb
+:org-remark-label: blue
+:org-remark-link: [[file:~/src/org-remark/demo/demo.txt::4]]
+:END:
diff --git a/resources/images/2022-01-22-Context-menu.png
b/resources/images/2022-01-22-Context-menu.png
new file mode 100644
index 0000000000..947d98934c
Binary files /dev/null and b/resources/images/2022-01-22-Context-menu.png differ
diff --git a/resources/images/2022-01-22-Title.png
b/resources/images/2022-01-22-Title.png
new file mode 100644
index 0000000000..465666972c
Binary files /dev/null and b/resources/images/2022-01-22-Title.png differ
diff --git a/resources/images/2022-01-22-code.png
b/resources/images/2022-01-22-code.png
new file mode 100644
index 0000000000..76339c8153
Binary files /dev/null and b/resources/images/2022-01-22-code.png differ
