"
- (* anything)
- "X"
- (* anything)
- "Y"
- (* anything)
- "Z"
- (* anything)))
-
-
-(deftest "Parallel blocks work as expected - Hard Columns"
- [parallel block]
- (⇝ (⟰ "#+begin_parallel 20% 60% 20% :bar green
- X
-
- ,#+columnbreak:
-
- Y
-
- ,#+columnbreak:
-
- Z
- ,#+end_parallel")
-
- ;; The result is 3 columns with a solid GREEN rule between them and it
- ;; contains the user's text along with the “#+columnbreak” evaluated at the
- ;; expected positions.
- "
"
- (* anything)
- "X"
- (* anything)
- "
"
- (* anything)
- "Y"
- (* anything)
- "
"
- (* anything)
- "Z"))
+ contents)
+ (if (s-contains-p " " cols) "
" ""))))))))
#+end_src
#+end_details
-#+html:
-#+begin_box Example
-_This_
-#+begin_src org :tangle no
-,#+begin_parallel 2 :bar t
-X
-
-,#+columnbreak:
-
-Y
-
-Z
-,#+end_parallel
-#+end_src
-
-_Yields_
-
-#+begin_parallel 2 :bar t
-X
-
-#+columnbreak:
-
-Y
-
-Z
-#+end_parallel
-#+end_box
-
-#+begin_center
-( The [[https://www.gnu.org/software/emacs/manual/html_mono/eww.html][Emacs Web Wowser]], ~M-x eww~, does not display =parallel= environments as
-desired. )
-#+end_center
-
** COMMENT Older setup :Possibly_delete:
:PROPERTIES:
:CUSTOM_ID: COMMENT-Older-setup
@@ -3981,7 +3873,7 @@ mode activation ---after such functions have been declared.
(defalias 'org--parallelNB
#'org--2parallelNB)
#+END_SRC
-* :fire: HTML Export Styles as Links
+* COMMENT :fire: HTML Export Styles as Links
:PROPERTIES:
:CUSTOM_ID: HTML-Export-Styles-as-Links
:END:
@@ -4072,7 +3964,7 @@ mode activation ---after such functions have been declared.
#+end_src
# html-export-style:solarized_light
-* Fortune Links: Smiles inside and outside of Emacs
+* COMMENT Fortune Links: Smiles inside and outside of Emacs
:PROPERTIES:
:CUSTOM_ID: Fortune-Links-Smiles-inside-and-outside-of-Emacs
:END:
@@ -4177,7 +4069,7 @@ When you click, it takes a seconds to fetch jokes; so await a moment when hoveri
result))
#+end_src
-* Editor Comments
+* COMMENT Editor Comments
:PROPERTIES:
:CUSTOM_ID: editor-comments
:END:
@@ -4574,7 +4466,7 @@ Completely lost one's train of thought…
#+bind: org-hide-editor-comments nil
-* Colours
+* COMMENT Colours
:PROPERTIES:
:CUSTOM_ID: Colours
:END:
@@ -5082,7 +4974,7 @@ Let's have some sanity tests...
generalisation would be when rendering text in multiple languages; e.g., use red
and blue to interleave Arabic poetry with its English translation.
-* Nice Keystroke Renditions: kbd:C-h_h
+* COMMENT Nice Keystroke Renditions: kbd:C-h_h
:PROPERTIES:
:CUSTOM_ID: kbd:nice-keystroke-renditions
:END:
@@ -5250,7 +5142,7 @@ Let's have some sanity tests...
#+HTML:
#+HTML:
:End:
-* /“Link Here!”/ & OctoIcons
+* COMMENT /“Link Here!”/ & OctoIcons
:PROPERTIES:
:CUSTOM_ID: Link-Here-OctoIcons
:END:
@@ -5388,7 +5280,7 @@ link-here:example-location (Click the icon and see the URL has changed!)
#+end_src
#+end_details
-* Badge Links
+* COMMENT Badge Links
:PROPERTIES:
:CUSTOM_ID: Badge-Links
:END:
@@ -6096,7 +5988,7 @@ wish to use; e.g., badge:|1d8348|1d8348
the LaTeX backend. {{{newline}}} [[remark:Author][That is why no examples are shown in the PDF]] It
may be useful to colour the =|=-separated fields of a badge link.
# This would make the interface more welcoming to new users.
-* Tooltips for Glossaries, Dictionaries, and Documentation
+* COMMENT Tooltips for Glossaries, Dictionaries, and Documentation
:PROPERTIES:
:CUSTOM_ID: Tooltips-for-Glossaries-Dictionaries-and-Documentation
:END:
@@ -6986,7 +6878,7 @@ and, finally, look for the documentation entry using `org-docs-fallback'."
(cdr (or (assoc label org--docs)
(assoc label org--docs-from-libraries)
(funcall org-docs-fallback label)
- (error "Error: No documentation-glossary entry for “%s”!" label))))
+ (unless org-export-with-broken-links (error "Error: No documentation-glossary entry for “%s”!" label)))))
(cl-defun org-docs-insert ()
"Insert a “doc:𝒳” link from user's documentation-glossary database.
@@ -7497,7 +7389,7 @@ block types; whereas they currently break the HTML export.
to its associated =#+begin_documentation= declaration block in the current
buffer, if possible.
-* Marginal, “one-off”, remarks
+* COMMENT Marginal, “one-off”, remarks
:PROPERTIES:
:CUSTOM_ID: Marginal-one-off-remarks
:END:
@@ -7962,7 +7854,7 @@ from∘to m = {! try it! }
#+end_margin
exercise to show that ℕ is fixedpoint of ~Maybe~.
-* Equational Proofs
+* COMMENT Equational Proofs
:PROPERTIES:
:CUSTOM_ID: Equational-Proofs
:END:
@@ -8475,7 +8367,7 @@ z
#+end_src
#+end_details
-* Case Studies
+* COMMENT Case Studies
** In doubt, a block's main argument should be enclosed in quotes
:PROPERTIES:
:CUSTOM_ID: In-doubt-a-block's-main-argument-should-be-enclosed-in-quotes
@@ -8536,7 +8428,6 @@ It is said that $e^{i \cdot \pi} + 1 = 0$ is the truth.
-
* TODO [#A] COMMENT Summary
:PROPERTIES:
:CUSTOM_ID: Summary
diff --git a/tests/e2e.el b/tests/e2e.el
index d5ae522..627effc 100644
--- a/tests/e2e.el
+++ b/tests/e2e.el
@@ -193,7 +193,7 @@ INDENT-LEVEL specifies the current indentation level, defaulting to 0."
(let ((seed 0))
(cl-letf (((symbol-function 'gensym)
(lambda () (format "g%s" (incf seed)))))
- (list
+ (list
(cons 'html
(with-temp-buffer
(org-special-block-extras-mode)
@@ -216,5 +216,37 @@ INDENT-LEVEL specifies the current indentation level, defaulting to 0."
(latex-mode) (format-all-buffer)))
(s-trim (buffer-string)))
(error (format "🚫 The LaTex backend is intentionally unmaintained.\n🫠 Whoops, there seems to be an error: \n %S" err)))))))
- 'hash-table))
-
+'hash-table))
+
+
+(defun my/hash-get-or-compute (hash key compute-fn)
+ "Retrieve or compute the value for KEY in HASH, and store it if computed."
+ (or (gethash key hash)
+ (let ((value (funcall compute-fn)))
+ (puthash key value hash)
+ value)))
+
+(defvar osbe-example-yaml-cache (make-hash-table :test 'equal)
+ "Cache to avoid time re-reading yaml files!")
+(org-defblock osbe-example (file)
+ "Render the given FILE as both Org source and rendered HTML result.
+
+The source is the `input' key; the target is the `expectations.html' key.
+
+Workflow: Write the `input' in an Org buffer, and once the export is to
+my liking, then move the `input' to the relevant yaml file."
+ (let* ((yaml (my/hash-get-or-compute osbe-example-yaml-cache
+ file
+ (lambda () (e2e--read-yaml-file file))))
+ (input (map-elt yaml 'input))
+ (src (s-trim input))
+ (tgt (map-elt (map-elt yaml 'expectations) 'html))
+ ;; "teal" "brown" "gray" "purple" "lime" "green" "blue" "orange" "peach" "pink" "yellow" "custard"
+ (src.color (org-subtle-colors "lime"))
+ (tgt.color (org-subtle-colors "peach")))
+ (cl-letf* (((symbol-function 'make-title) (lambda (it) (format "
﴾%s﴿
" it)))
+ (src.title (make-title "What You Write"))
+ (tgt.title (make-title "What You Get")))
+ (format "
"
+ src.color src.title src
+ tgt.color tgt.title tgt))))
diff --git a/tests/osbe-example.yaml b/tests/osbe-example.yaml
new file mode 100644
index 0000000..f9d6c45
--- /dev/null
+++ b/tests/osbe-example.yaml
@@ -0,0 +1,47 @@
+input: |-
+ Look:
+
+ #+begin_osbe-example
+ hola
+ #+end_osbe-example
+no-prettier: "t"
+expectations:
+ expansion: |-
+ #+setupfile: https://gitlab.com/OlMon/org-themes/-/raw/master/src/solarized_light/solarized_light.theme
+ Look:
+
+
The ~rename~ block is for Textual Substitution. For example, as a translation tool:
+
+ #+begin_rename "Allah to God, Yacoub to Jacob, Yusuf to Joseph"
+ Quran 12-4: *_Yusuf_* said to his father ( _*Yacoub*_ ), /“O my father,
+ indeed I have seen (in a dream) eleven stars and the sun and the
+ moon; I saw them prostrating to me.”/
+ #+end_rename
+
+ In the rendered result, the Arabic names are replaced with their English counterparts.
+ html: |-
+
+ Look:
+
+
+
The ~rename~ block is for Textual Substitution. For example, as a translation tool:
+
+ #+begin_rename "Allah to God, Yacoub to Jacob, Yusuf to Joseph"
+ Quran 12-4: *_Yusuf_* said to his father ( _*Yacoub*_ ), /“O my father,
+ indeed I have seen (in a dream) eleven stars and the sun and the
+ moon; I saw them prostrating to me.”/
+ #+end_rename
+
+ In the rendered result, the Arabic names are replaced with their English counterparts.
+ latex: |-
+ Look:
+
+
The ~rename~ block is for Textual Substitution. For example, as a translation tool:
+
+ #+begin_rename "Allah to God, Yacoub to Jacob, Yusuf to Joseph"
+ Quran 12-4: *_Yusuf_* said to his father ( _*Yacoub*_ ), /“O my father,
+ indeed I have seen (in a dream) eleven stars and the sun and the
+ moon; I saw them prostrating to me.”/
+ #+end_rename
+
+ In the rendered result, the Arabic names are replaced with their English counterparts.
diff --git a/tests/parallel.yaml b/tests/parallel.yaml
index bbf4cd6..1e15ef7 100644
--- a/tests/parallel.yaml
+++ b/tests/parallel.yaml
@@ -1,185 +1,88 @@
input: |-
- In the HTML Export, The result is 2 columns with no rule between
- them and it contains the user's text, but ignores the
- “#+columnbreak”.
-
- #+begin_parallel
- Hello, to the left!
-
- #+columnbreak:
- A super duper wide middle margin!
-
-
- #+columnbreak:
- Goodbye (“God-be-with-ye”) to the right!
-
- #+columnbreak:
- woah
+ Articles can get lengthy when vertical whitespace is wasted on thin
+ lines; instead, one could save space by using
+ /[[doc:org-block/parallel][parallel]] columns of text/.
+
+ ----------------------------------------------------------------------
+
+ #+begin_parallel 2
+ *“Soft Columns”:* Writing ~#+begin_parallel 𝓃 :bar BAR~ will produce
+ 𝒏-many parallel columns, possibly separated by solid rules, or a
+ “bar”. /This style allows text to freely move between columns,
+ depending on the size of the browser, which may dynamically shrink
+ and grow./ The value ~BAR~ can either be ~t~, ~nil~, or any
+ (backend)-valid colour specification; such as ~red~ or ~green~.
#+end_parallel
+ ----------------------------------------------------------------------
- [Soft Columns] Below, the result is 2 columns with a solid BLACK
- rule between them and it contains the user's text, but ignores the
- “#+columnbreak”.
+ #+begin_parallel 25% 50% 25% :bar green
- #+begin_parallel 2 :bar t
- X
+ *“Hard Columns”:* Alternatively, /for non-uniform column widths, 𝓃 may
+ instead be a specification of the widths of the columns./
- #+columnbreak:
-
- Y
-
- Z
- #+end_parallel
-
-
- [Hard Columns] The result is 3 columns with a solid GREEN rule
- between them and it contains the user's text along with the
- “#+columnbreak” evaluated at the expected positions.
- #+begin_parallel 20% 60% 20% :bar green X
+ #+columnbreak:
+ However, this extra flexibility comes at an additional cost: The
+ contents of the block must now contain /𝓃-1/ lines consisting of
+ ~#+columnbreak:~, when the specification determines 𝓃-many columns.
#+columnbreak:
+ Goodbye (“God-be-with-ye”) to the right!
- Y
+ #+end_parallel
- #+columnbreak:
+ # Moreover:
+ # → In the Soft Columns style above, any ‘#+columnbreak:’ are merely ignored.
+ # → With LaTeX export, the use of ‘#+columnbreak:’ is used to request a column break.
+ # \usepackage{multicol}
- Z
- #+end_parallel
-no-prettier: t
expectations:
html: |-
- In the HTML Export, The result is 2 columns with no rule between
- them and it contains the user's text, but ignores the
- “#+columnbreak”.
-
-
-
-
- Hello, to the left!
-
-
-
- A super duper wide middle margin!
-
-
-
-
- Goodbye (“God-be-with-ye”) to the right!
-
-
-
- woah
-
-
-
-
-
-
- [Soft Columns] Below, the result is 2 columns with a solid BLACK
- rule between them and it contains the user's text, but ignores the
- “#+columnbreak”.
-
-
-
-
- X
+ Articles can get lengthy when vertical whitespace is wasted on thin
+ lines; instead, one could save space by using
+ parallel columns of text.
-
- Y
-
+
+
- Z
+ “Soft Columns”: Writing #+begin_parallel 𝓃 :bar BAR will produce
+ 𝒏-many parallel columns, possibly separated by solid rules, or a
+ “bar”. This style allows text to freely move between columns,
+ depending on the size of the browser, which may dynamically shrink
+ and grow. The value BAR can either be t, nil, or any
+ (backend)-valid colour specification; such as red or green.
+
-
- [Hard Columns] The result is 3 columns with a solid GREEN rule
- between them and it contains the user's text along with the
- “#+columnbreak” evaluated at the expected positions.
-
-
+
+
“Hard Columns”: Alternatively,
for non-uniform column widths, 𝓃 may
+ instead be a specification of the widths of the columns.
- Y
+
+ However, this extra flexibility comes at an additional cost: The
+ contents of the block must now contain
𝓃-1 lines consisting of
+
@@html:</div><div style="width: 25%; margin: 10px; border-right:4px none; float: left;">@@, when the specification determines 𝓃-many columns.
-
+
+ Goodbye (“God-be-with-ye”) to the right!
-
- Z
-
-
+
latex: |-
- In the HTML Export, The result is 2 columns with no rule between
- them and it contains the user's text, but ignores the
- “\#+columnbreak”.
-
- \par \setlength{\columnseprule}{0 pt}
- \begin{minipage}[t]{\linewidth}
- \begin{multicols}{2}
- Hello, to the left!
-
- \columnbreak
- A super duper wide middle margin!
-
-
- \columnbreak
- Goodbye (“God-be-with-ye”) to the right!
-
- \columnbreak
- woah
-
-
- \end{multicols}\end{minipage}
-
-
- {[}Soft Columns] Below, the result is 2 columns with a solid BLACK
- rule between them and it contains the user's text, but ignores the
- “\#+columnbreak”.
-
- \par \setlength{\columnseprule}{2 pt}
- \begin{minipage}[t]{\linewidth}
- \begin{multicols}{2}
- X
-
- \columnbreak
-
- Y
-
- Z
-
-
- \end{multicols}\end{minipage}
-
-
- {[}Hard Columns] The result is 3 columns with a solid GREEN rule
- between them and it contains the user's text along with the
- “\#+columnbreak” evaluated at the expected positions.
- \par \setlength{\columnseprule}{2 pt}
- \begin{minipage}[t]{\linewidth}
- \begin{multicols}{20% 60% 20%}
-
- \columnbreak
-
- Y
-
- \columnbreak
-
- Z
-
-
- \end{multicols}\end{minipage}
+ 🚫 The LaTex backend is intentionally unmaintained.
+ 🫠 Whoops, there seems to be an error:
+ (void-variable label)
diff --git a/tests/rename.yaml b/tests/rename.yaml
index 110453f..434c3cb 100644
--- a/tests/rename.yaml
+++ b/tests/rename.yaml
@@ -7,7 +7,7 @@ input: |-
moon; I saw them prostrating to me.”/
#+end_rename
- In the rendered result, the Arabic names are replaed with their English counterparts.
+ In the rendered result, the Arabic names are replaced with their English counterparts.
expectations:
html: |-