Re: Where is Elisp evaluation documented in the Org Manual?

[Perry Smith]

> On Sep 30, 2022, at 11:07, Max Nikulin  wrote:
> 
> On 30/09/2022 21:15, Perry Smith wrote:
> 
>> I discovered that it can be done like {{{kbd(M-TAB)}}}
>> Fascinating!!!  And I bet expr in the form of {{{ expr }}} could be any 
>> Elisp expression.  Cool!
>> But, where in the Org manual is this documented?
> 
> See info "(org) Macro Replacement" 
> https://orgmode.org/manual/Macro-Replacement.html
> 
> If you are interested in particular in the implementation of kbd then have a 
> look into doc/doc-setup.org and lisp/ox-texinfo.el files in the Org sources.
> 
> There are a pitfall with comma as macro argument separator. It is easy to 
> forgot to escape it and to loose remaining arguments.

Thank you…

For others following along, the reference is doc/misc/org-setup.org and 
lisp/org/ox-texinfo.el in the source tree.

Also, I searched for {{{ in org.org but I failed to notice that some were 
escaped with == such as:

which can be referenced using ={{{name(arg1, arg2)}}}=

(making the text inside a verbatim).

Thank you again.



signature.asc
Description: Message signed with OpenPGP

Where is Elisp evaluation documented in the Org Manual?

[Perry Smith]

I wanted to format a key binding in Org mode and, of course, I wanted to do it 
properly so I started surfing around and then hit upon the idea of just looking 
at the source of the Org manual for examples.

I discovered that it can be done like {{{kbd(M-TAB)}}}

Fascinating!!!  And I bet expr in the form of {{{ expr }}} could be any Elisp 
expression.  Cool!

But, where in the Org manual is this documented?  I’m curious what other things 
are possible.  So far, I’ve not been able to find it.  I did find something 
about Capture Templates but I’m not at that pay grade yet.

(I’m not on the list so please CC me on your replies)
Thank you,
Perry


signature.asc
Description: Message signed with OpenPGP

#+ candidates

[Perry Smith]

The manual says I can type #+ and then hit M-tab to get the list of 
completions.  In my case, flyspell-mode had stolen that key binding so I 
disabled flyspell-mode.

There are 100 #+ candidates.  Is there a nice place that lists them and 
documents each one?  So far, I’ve yet to find one.  It is sometimes nice to 
browse through such a list just to become familiar with what is possible.

Thank you,
Perry



signature.asc
Description: Message signed with OpenPGP

Re: Org mode "style sheet" for software documentation

[Perry Smith]

> On Sep 9, 2022, at 00:09, Ihor Radchenko  wrote:
> 
> Perry Smith  writes:
> 
>> So… it seems I didn’t the two BORDER characters do not need to match.  So 
>> I’m off trying to figure out a way to create more emphasis MARKERS.  In the 
>> old days, we had only about 43 non-alphanumeric characters to play with but 
>> now with Emacs being 8 bit clean for countless years we have another 128 
>> characters and with UTF-8 we have bazillians more!
>> 
>> So I’m gently poking around in the code to see how hard it would be to 
>> define more.
> 
> We currently do not support extensions to emphasis, though we may do it
> in future. See https://orgmode.org/list/87letvrege.fsf@localhost
> 
> Implementing new emphasis markers will require introducing a new syntax
> object into org-element.el. Such object will unlikely be using a
> single-char markers - single-char markers are problematic in numerous
> edge cases; we should better introduce something closer to inline src
> block syntax to allow arbitrary emphasis extensions.

I’m now retired with time on my hands so ping me if I can help somehow if / 
when the time
comes.  I sometimes turn off receiving from the list so drop me an email 
directly to
make sure I see it.

Perry



signature.asc
Description: Message signed with OpenPGP

Re: Org mode "style sheet" for software documentation

[Perry Smith]

> On Sep 8, 2022, at 11:20, Perry Smith  wrote:
> 
> I don’t understand this page: 
> https://orgmode.org/worg/dev/org-syntax.html#Emphasis_Markers 
> <https://orgmode.org/worg/dev/org-syntax.html#Emphasis_Markers>
> 
> In particular, the BORDER BODY BORDER part.  Note that this is the CONTENT 
> which is already between MARKERS.
> 
> What I *think* I want is the ability to effectively create what I’ll call 
> “macros”.  I’d like to be able to separate out things like file paths, code 
> samples (both in line and block), keywords, environment variables, code 
> variables, etc.  So, as I write, I would do (as a total pretend example) 
> [var]foo_dog[var] to denote foo_dog as a code variable.  I’m wondering if 
> that isn’t what the “BORDER” character is.  From the way the section is 
> written, I would assume the leading border character must be the same as the 
> trailing border character so I could do ~vfoo_docv~  where the “v” would be 
> the border character?
> 
> OR… perhaps what this is trying to tell me is the first character after the 
> leading marker and the last character before the trailing marker must not be 
> whitespace characters since that is how it appears from all of the examples.
> 
> My logic is if I take the time to separate out all of the elements as I write 
> the document, then I can later decide to format, for example, code snippets 
> the same as variables.  It would also help me to be more consistent while I 
> write because I’m (currently) having to remember “Ok… how did I format 
> variables?  Was that ‘code' or ‘italics'? … Hmm…”
> 
> If I’ve misunderstood this page, then perhaps to save a follow up email, can 
> someone tell me if I can create “macros” within Org mode to do what I 
> mentioned OR tell me that I really don’t want to go down that path for some 
> reason.

From the code:
Terminology:  In an emphasis string
like " *strong word* ", we call the initial space PREMATCH, the final
space POSTMATCH, the stars MARKERS, "s" and "d" are BORDER characters
and "trong wor" is the body.

The code has clearer documentation than the documentation :-)

So… it seems I didn’t the two BORDER characters do not need to match.  So I’m 
off trying to figure out a way to create more emphasis MARKERS.  In the old 
days, we had only about 43 non-alphanumeric characters to play with but now 
with Emacs being 8 bit clean for countless years we have another 128 characters 
and with UTF-8 we have bazillians more!

So I’m gently poking around in the code to see how hard it would be to define 
more.

pedz



signature.asc
Description: Message signed with OpenPGP

Org mode "style sheet" for software documentation

[Perry Smith]

I don’t understand this page: 
https://orgmode.org/worg/dev/org-syntax.html#Emphasis_Markers 


In particular, the BORDER BODY BORDER part.  Note that this is the CONTENT 
which is already between MARKERS.

What I *think* I want is the ability to effectively create what I’ll call 
“macros”.  I’d like to be able to separate out things like file paths, code 
samples (both in line and block), keywords, environment variables, code 
variables, etc.  So, as I write, I would do (as a total pretend example) 
[var]foo_dog[var] to denote foo_dog as a code variable.  I’m wondering if that 
isn’t what the “BORDER” character is.  From the way the section is written, I 
would assume the leading border character must be the same as the trailing 
border character so I could do ~vfoo_docv~  where the “v” would be the border 
character?

OR… perhaps what this is trying to tell me is the first character after the 
leading marker and the last character before the trailing marker must not be 
whitespace characters since that is how it appears from all of the examples.

My logic is if I take the time to separate out all of the elements as I write 
the document, then I can later decide to format, for example, code snippets the 
same as variables.  It would also help me to be more consistent while I write 
because I’m (currently) having to remember “Ok… how did I format variables?  
Was that ‘code' or ‘italics'? … Hmm…”

If I’ve misunderstood this page, then perhaps to save a follow up email, can 
someone tell me if I can create “macros” within Org mode to do what I mentioned 
OR tell me that I really don’t want to go down that path for some reason.

Thank you for your help,
Perry



signature.asc
Description: Message signed with OpenPGP

Simple but repetitive http links

[Perry Smith]

I'm new to Org mode.  I found this page
https://orgmode.org/manual/Link-Abbreviations.html about Link
Abbreviations but I wanted to report my confusion.

I added:

#+LINK: rails  https://rubyonrails.org

to my org file and then I wrote [[rails][Rails]] and when I clicked
the text, it asked me if I wanted to create a section.  I had to kill
the buffer and reload it to get it to work.  That's fine but I'm
wondering if there is a way to make it active without killing the
buffer.  And I also wanted to suggest adding something about that in
the manual.

Perhaps this is a common fact with many of Org modes features that I
missed somewhere?

Thank you for your time,
Perry



signature.asc
Description: Message signed with OpenPGP

Footnote 60 in Org Manual

[Perry Smith]

The text has “For example, to specify a date December 12, 2005 …” and then all 
of the examples use 12 and 1 as if the intention was “to specify a date 
December 1, 2005”.  I doubt if you want to use December 12 because the 
specification would be 12 12 2005 but it would be hard to tell the user which 
12 is which. :-)

Hope this helps,
Perry



signature.asc
Description: Message signed with OpenPGP

Org.texi (the Org Manual) in ePub format

[Perry Smith]

I joined this list about a month ago to ask how I could get the manual in ePub 
format but I also started searching.  Long story short, I joined the TexInfo 
Help mailing list and submitted a question[1] (which also references two other 
threads if you are interested).

The net net net is you may pick up the Org manual in ePub format here [2].  As 
soon as the new modifications to TexInfo are pushed out, it is drop dead easy 
to produce ePub from the texi file.

For Apple losers like me, ePub is so much nicer than PDFs in Apple Books.  All 
the features come to life such as book marks, notes, highlighting, etc.  And 
they are saved.  Almost like we rocketed into 1990.

Perhaps now that it is so easy thanks to the wonderful people supporting 
TexInfo, ePub will become a more common format that is produced and maintained 
by open source groups.

I hope to eventually learn how to use Org mode to do time tracking of my 
various software projects.  It looks very promising.

Take care,
Perry
p.s. if you are curious, please visit my photography web site [3]

[1] https://lists.gnu.org/archive/html/help-TexInfo/2022-06/msg2.html 

[2] http://why-not-photography.com/drop/org.epub 

[3] http://why-not-photography.com 



signature.asc
Description: Message signed with OpenPGP