From ec176e1c2629b7118eaeb5decc1a4f36d6cf45ff Mon Sep 17 00:00:00 2001 From: Bhavin Gandhi Date: Thu, 10 Dec 2020 23:56:58 +0530 Subject: Formatting, typos - talk 14-20 --- 2020/info/14.md | 119 +++++++++++++++++++++++++++++++++----------------------- 2020/info/15.md | 40 +++++++++---------- 2020/info/16.md | 70 ++++++++++++++++----------------- 2020/info/17.md | 66 +++++++++++++++---------------- 2020/info/18.md | 45 +++++++++++---------- 2020/info/19.md | 25 ++++++------ 2020/info/20.md | 29 +++++++------- 7 files changed, 206 insertions(+), 188 deletions(-) (limited to '2020/info') diff --git a/2020/info/14.md b/2020/info/14.md index 2a65c88e..55f86fcc 100644 --- a/2020/info/14.md +++ b/2020/info/14.md @@ -11,73 +11,96 @@ documentation. This strategy is a great way to keep your documentation from getting outdated, and it allows you to use all the other wonderful features of org-mode. Watch "README-Driven Design" to see exactly how to make your README file a powerful literate document. -- [Companion Blog Post](http://adamard.com/literate_programming.html) -- [Extended Version of Demo File](https://github.com/adam-ard/literate-demo) -- [Literate Static Website](https://github.com/adam-ard/static-website-literate-demo) - -- Actual start and end time (EST): Start 2020-11-28T14.15.00; End: 2020-11-28T14.34.46 - - -# Questions - - -## If you put all your code in an org file (in addition to prose), doesn't that make the file very large for medium/large projects? (Since all the code across all files is tangled from a single README.org) -You are right it would get pretty large. I haven't hit that point yet, but plan to experiment with separate org files that are imported into a master file. - - -## If a collaborator edits the tangled file(s), is reverse-tangling in org reliable? How do you integrate the reverse in a safe way? - -So, I actually think this is the big unsolved problem right now. How to do reverse tangling. As far as I know, emacs doesn't do that. But it would really cool. I think it is probably a hard problem. -- actually it does! you have to enable comments that mark the boundaries of the code blocks. (org-babel-detangle) -> org-babel-detangle is pretty fragile right now. -- Oh wonderful! I will have to check that out. There is always more to discover in emacs. Thanks! +- [Companion Blog Post](http://adamard.com/literate_programming.html) +- [Extended Version of Demo File](https://github.com/adam-ard/literate-demo) +- [Literate Static Website](https://github.com/adam-ard/static-website-literate-demo) + -## Would this approach make it harder to collaborate with contributors who don't use org?/How to rectify these difficulties? (Thank you!) +- Actual start and end time (EST): Start: 2020-11-28T14.15.00; End: + 2020-11-28T14.34.46 -I have had some sucess at work by managing an org file myself, then I commit the tangled code and a README.md. I have to manually update my org file though when someone makes a change to the raw source files. That process can be a pain. It would be awesome to find a way to make this easier. So that non-emacs users can collaborate and be unaware of the source org file. To have an annotation free reverse tangling process would be the holy grail of literate programming. Would be a great thesis project for someone. +# Questions +## If you put all your code in an Org file (in addition to prose), doesn't that make the file very large for medium/large projects? (Since all the code across all files is tangled from a single README.org) +You are right it would get pretty large. I haven't hit that point yet, +but plan to experiment with separate Org files that are imported into +a master file. + +## If a collaborator edits the tangled file(s), is reverse-tangling in Org reliable? How do you integrate the reverse in a safe way? +So, I actually think this is the big unsolved problem right now. How +to do reverse tangling. As far as I know, Emacs doesn't do that. But +it would really cool. I think it is probably a hard problem. + +- Actually it does! You have to enable comments that mark the + boundaries of the code blocks. (org-babel-detangle) -> + org-babel-detangle is pretty fragile right now. +- Oh wonderful! I will have to check that out. There is always more to + discover in Emacs. Thanks! + + +## Would this approach make it harder to collaborate with contributors who don't use Org? / How to rectify these difficulties? (Thank you!) +I have had some sucess at work by managing an Org file myself, then I +commit the tangled code and a README.md. I have to manually update my +Org file though when someone makes a change to the raw source +files. That process can be a pain. It would be awesome to find a way +to make this easier. So that non Emacs users can collaborate and be +unaware of the source Org file. To have an annotation free reverse +tangling process would be the holy grail of literate +programming. Would be a great thesis project for someone. ## Interesting. Did you ever use this approach on a large project? Could one incorporate also TDD into this workflow? +I have only really hit the medium size. But would love to try a larger +one. I have seen people write whole books in literate progamming +though. (Not sure if they were using Emacs) (one example: + ). Here is a pretty large one I found on +GitHub: . -I have only really hit the medium size. But would love to try a larger one. I have seen people write whole books in literate progamming though. (Not sure if they were using emacs) (one example: ). Here is a pretty large one I found on github: - -TDD is an interesting idea. I haven't tried doing that, but org seems flexible enough to build a workflow around that. - +TDD is an interesting idea. I haven't tried doing that, but Org seems +flexible enough to build a workflow around that. ## Could you share the snippet for adding these source code blocks, it seems much better than the one I am using currently. Thanks! - -Sure, it is documented in the literate programming demo here ( ) +Sure, it is documented in the literate programming demo here +(). -## In Python, indentation is part of the syntax. How is this handled when -syntax is used for functions or even a few lines of codes that are get re-used in multiple functions? Does the user have to define different snippets for different indentations but otherwise identical code? - -Not the speaker, but :noweb will add the prefix characters to all lines, see . Python identation is fine (and used as an example in the manual :)) -- exactly, I have done a lot of python this way, it works great! +## In Python, indentation is part of the syntax. How is this handled when <>-syntax is used for functions or even a few lines of codes that are get re-used in multiple functions? Does the user have to define different <> snippets for different indentations but otherwise identical code? +Not the speaker, but `:noweb` will add the prefix characters to all +lines, see +. Python +identation is fine (and used as an example in the manual :)) +- Exactly, I have done a lot of Python this way, it works great! ## Could this structure be used with a SQL query with the output being an Org table? - -Yep, I have done that before too. Org will send the query to a database and insert the results. It is super nice. You can add block properties to set the hostname of the database too, so it isn't limited to just databases running on your local machine. +Yep, I have done that before too. Org will send the query to a +database and insert the results. It is super nice. You can add block +properties to set the hostname of the database too, so it isn't +limited to just databases running on your local machine. ## Why do you export to Markdown when GitHub and others are supporting rendering Org directly? - -Good question. I do this because I usually work with people that don't use emacs :( so I usually take the source files and the markdown and commit them to git. I keep the org file to myself. If everyone used emacs, I wouldn't bother with that step. - +Good question. I do this because I usually work with people that don't +use Emacs :( so I usually take the source files and the Markdown and +commit them to Git. I keep the Org file to myself. If everyone used +Emacs, I wouldn't bother with that step. ## This file would be very useful to have for us for reference, could you also share it please? - -Yep! See the links below for a couple template files. An extended one from the talk is at: - +Yep! See the links below for a couple template files. An extended one +from the talk is at: # Notes -- Adam Ard: I'll be answering questions here in the pad or in #emacsconf (aard3) -- Companion Blog Post: -- Extended Version of Demo File: -- Literate Static Website: -- If you want to learn what GitHub is able to render in Org syntax: -- -- I am thinking about org-transclusion; similar ideas to deal with notes instead of codes - - FYI: - +- Adam Ard: I'll be answering questions here in the pad or in + #emacsconf (aard3). +- Companion Blog Post: . +- Extended Version of Demo File: + . +- Literate Static Website: + . +- If you want to learn what GitHub is able to render in Org syntax: + . +- . +- I am thinking about org-transclusion; similar ideas to deal with + notes instead of codes. + - FYI: . diff --git a/2020/info/15.md b/2020/info/15.md index aa1dee11..dd288c64 100644 --- a/2020/info/15.md +++ b/2020/info/15.md @@ -17,36 +17,34 @@ Logic website to Org Mode. -- Actual start and end time (EST): Start 2020-11-28T14.36.18; Q&A: 2020-11-28T14.51.48; End 2020-11-28T14.53.03 - +- Actual start and end time (EST): Start: 2020-11-28T14.36.18; Q&A: + 2020-11-28T14.51.48; End: 2020-11-28T14.53.03 # Questions - -## Opinion on Firn ( ) ? - +## Opinion on Firn ()? ## Do you discuss this in a blog as well? Where could I find more about it? - -Talk and content will be published later after the conference. Will be available on the talk page. - +Talk and content will be published later after the conference. Will be +available on the talk page. ## Could you please paste your URLs in the notes below? (link to your site etc). +The source repository of the first website (my homepage) lives here: + and the output is: +. -The source repository of the first website (my homepage) lives here: and the output is: +The source repository of the second website (Computational Logic) +lives here: and the +output is: . -The source repository of the second website (Computational Logic) lives here: and the output is: - -The talk, code and links are now availble here: - - -## has the source code for the website. +The talk, code and links are now availble here: +. + has the source code for the +website. # Notes - -- Main reason: Org has better support for literate programming. -- Org mode files support in Jekyll - -- Mentioned: (org-thml) -- Other static webpage generators: - +- Main reason: Org has better support for literate programming. +- Org mode files support in Jekyll - . +- Mentioned: (org-html). +- Other static webpage generators: . diff --git a/2020/info/16.md b/2020/info/16.md index ec2e40a7..e298e06f 100644 --- a/2020/info/16.md +++ b/2020/info/16.md @@ -30,29 +30,30 @@ Examples of short-presentations I've recorded in the past: -- Actual start and end time (EST): Start 2020-11-28T14.54.36; Q&A: 2020-11-28T15.12.44; End 2020-11-28T15.15.51 +- Actual start and end time (EST): Start: 2020-11-28T14.54.36; Q&A: + 2020-11-28T15.12.44; End: 2020-11-28T15.15.51 -# Questions from the pad +# Questions ## What is the functionality of `org-roam-unlinked-references`? - -Let's say we have Emacs in another note… for every mention of Emacs that is not linked, it prints all the results in the buffer. +Let's say we have Emacs in another note… for every mention of +Emacs that is not linked, it prints all the results in the buffer. ## How would org-roam files which would be very numerous integrate with todo's and org-agenda -## Is it possible to use the backlinks feature in regular org buffers? - -We have a very controlled environment and this is where we keep all the notes +## Is it possible to use the backlinks feature in regular Org buffers? +We have a very controlled environment and this is where we keep all +the notes. ## Do you make your org-roam database accessible accross computers? Via putting the SQLite file in Dropbox or serving the DB in the cloud or something. - - Answer: no. Only on one computer personally. -- But plenty of people have done so. Section in the manual dedicated to this. -- pretty sure best results occur when the DB is generated seperately for each machine. +- But plenty of people have done so. Section in the manual dedicated + to this. +- Pretty sure best results occur when the DB is generated seperately + for each machine. ## How do you discover tags/links to add to a new org-roam note? - -… go to org-roam.com, on Github we show everything +… go to org-roam.com, on GitHub we show everything. ## Do you share your org-roam knowledgebase in a public location? @@ -63,36 +64,35 @@ We have a very controlled environment and this is where we keep all the notes ## What is the best way to keep a separate org-roam (dir) for work and home/personal? ## Are the timestamp prefixes in the filenames optional? - -yes, you can modify the prefixe +Yes, you can modify the prefixe. ## Just want to say good on you Leo! Perserverence! -## Is there an easy way to export several selected notes, to say, a LaTeX file? - -At the very core it is Org Mode - - has some notes about exporting from Org Roam to regular Org -Yes, sorry, I meant to put together several "atoms" for export. - -## try org-transclusion to make new notes and export to latex file. +## Is there an easy way to export several selected notes, to say, a LaTeX file? +At the very core it is Org Mode. + +has some notes about exporting from Org Roam to regular Org +- Yes, sorry, I meant to put together several "atoms" for export. +- Try org-transclusion to make new notes and export to LaTeX file. ## How do tags fit into org-roam workflow? - -## You mentioned you have a youtube channel. Could you give us the link to it. I would definitely be interested in watching your videos. Yeah, I didnt see it. Thanks :D - +## You mentioned you have a YouTube channel. Could you give us the link to it. I would definitely be interested in watching your videos. Yeah, I didnt see it. Thanks :D (Check the notes below). # Notes -- Maintainer of -- "Org Roam is a way for you to manage backlinks inside of Emacs" links - backlinks -- I see logseq ( ) as a bridge to link non-emacs users to Emacs world. -- Org-roam is awesome. As a friendly challenge, Karl wrote - - - You should check out the cool discussions on which mentiones tons of advantages of org-roam/Zettelkasten - - - If you checked out Zettelkasten and you're looking for a simpler alternative for just bi-directional linking headings (but none of the other great features of Zettelkasten): -- "The point is to make consistency of your notes." -- YouTube channel: +- Maintainer of +- "Org Roam is a way for you to manage backlinks inside of Emacs" + links - backlinks +- I see logseq ( ) as a bridge to link non Emacs + users to Emacs world. +- Org-roam is awesome. As a friendly challenge, Karl wrote + . + - You should check out the cool discussions on which mentiones tons of advantages of org-roam/Zettelkasten + - If you checked out Zettelkasten and you're looking for a simpler + alternative for just bi-directional linking headings (but none of + the other great features of Zettelkasten): + . +- "The point is to make consistency of your notes." +- YouTube channel: . diff --git a/2020/info/17.md b/2020/info/17.md index 8d2057f4..b2c070f1 100644 --- a/2020/info/17.md +++ b/2020/info/17.md @@ -26,60 +26,56 @@ I will talk briefly about the packages and special-use cases for each stage and learned lessons along the way. Finally, the presentation concludes with future considerations and possible org-mode features. - - +- Slides/presentation: -- Actual start and end time (EST): Start 2020-11-28T15.17.33; Q&A: 2020-11-28T15.32.18 End 2020-11-28T15.39.00 -- Slides/presentation: + +- Actual start and end time (EST): Start: 2020-11-28T15.17.33; Q&A: + 2020-11-28T15.32.18; End: 2020-11-28T15.39.00 # Questions - -## I use org-roam-bibtex to take notes on particular academic papers in conjuction with org-noter. This means all notes for a given paper are in one org file. However while it is possible to link to headings within a file, there is no functionality to easily search through and link to these subheadings. What do you do to overcome this? I've only superficially looked at org-rifle as a possible method. +## I use org-roam-bibtex to take notes on particular academic papers in conjuction with org-noter. This means all notes for a given paper are in one Org file. However while it is possible to link to headings within a file, there is no functionality to easily search through and link to these subheadings. What do you do to overcome this? I've only superficially looked at org-rifle as a possible method. ## Whats this presentation software? Looks really cool. - beamer (LaTeX) - for the slides/presentation - + for the +slides/presentation. ## How does the view for time blocking works? +## have you seen the project Papis? I think the author is working on an Emacs package, what would be your thoughts? (it's a Zotero alternative) +"Powerful and highly extensible command-line based document and +bibliography manager." -## have you seen the project papis ? I think the author is working on an emacs package, what would be your thoughts? (it's a zotero alternative) - -"Powerful and highly extensible command-line based document and bibliography manager." - - -## Did you try using ebib instead of zotero? if so, is zotero better in some way? - -Zotero has a lot of plugins you can play with and so far it's been great +## Did you try using ebib instead of Zotero? If so, is Zotero better in some way? +Zotero has a lot of plugins you can play with and so far it's been +great. -Some people have been using a connector between Emacs & Zotero… - -You can create groups for collaborative projects in Zotero and this is a plus. (thanks for the answers! I'll give it a try!) +Some people have been using a connector between Emacs & Zotero…. +You can create groups for collaborative projects in Zotero and this is +a plus. (thanks for the answers! I'll give it a try!). - maybe useful ^^ - ## Do you have any suggestions on what subjects/things should be tags/separate org-roam files for cross-linking? I've been struggling with whether making almost every term be a link or only using links for broader subjects. - -"Should I be combining ideas together into one…?" So far I've been using the Org Roam default way. - +"Should I be combining ideas together into one…?" So far I've +been using the Org Roam default way. ## Meta question: is there a place where people are collaborating on research "about" Emacs? - -Definitely interested, but there is no place (yet!) - +Definitely interested, but there is no place (yet!). # Notes - -- org-inlinetasks -- if you're working on a big org file that you keep coming back to, it's better to keep track of todo's related to that file within that file (e.g. a paper that you're writing) -- to keep track of todo's within a large file -- using org-gcal to sync gmail calendar with org-file -- org-transclusion to show (parts of) other files inline and allow editing in a separate mini-buffer -- There is a Slack channel for org-roam link/backlink pls? - +- org-inlinetasks. +- If you're working on a big Org file that you keep coming back to, + it's better to keep track of todo's related to that file within that + file (e.g. a paper that you're writing). +- to keep track of todo's + within a large file. +- Using org-gcal to sync gmail calendar with org-file + . +- org-transclusion to + show (parts of) other files inline and allow editing in a separate + mini-buffer. +- There is a Slack channel for org-roam link/backlink pls? diff --git a/2020/info/18.md b/2020/info/18.md index 8dcb3ad0..6633c598 100644 --- a/2020/info/18.md +++ b/2020/info/18.md @@ -39,42 +39,41 @@ Points to be covered -- Actual start and end time (EST): Start 2020-11-28T15.39.41; Q&A 2020-11-28T15.56.29; End 2020-11-28T16.01.03 - +- Actual start and end time (EST): Start: 2020-11-28T15.39.41; Q&A: + 2020-11-28T15.56.29; End: 2020-11-28T16.01.03 # Questions - ## Why not to run a background Emacs for parsing instead of implement a new parser? - -Running a background Emacs progress sounds great, but is still limited. Forwarding all queries to a background Emacs (like org-mode's exporter does) is only feasible with a (??? zaeph can probably fix the answer) - +Running a background Emacs progress sounds great, but is still +limited. Forwarding all queries to a background Emacs (like org-mode's +exporter does) is only feasible with a (??? zaeph can probably fix the +answer). ## How often does the DB index get updated in order to contain changes within Org files? - Either on save, or on idle-timer. - ## Did you ever think of opening up (or designing) the SQL DB as a general Org speedup-tool outside of org-roam so that other libraries that do execute complex queries are able to re-use the summarized data? +FYI, see John Kitchin's work, he uses a SQLite database to index his +Org +files. . -FYI, see John Kitchin's work, he uses a SQLite database to index his Org files. -- John's DB approach is great. However, we should not end up using several DB-index in parallel. ;-)+1 +- John's DB approach is great. However, we should not end up using + several DB-index in parallel. ;-)+1 +## Obviously with the 'global backlinks' agenda, it would be interesting to combine with the eev stuff from before :-) () -## Obviously with the 'global backlinks' agenda, it would be interesting to combine with the eev stuff from before :-) ( ) - - -## about the external program, you could just talk to the PANDOC guys (or Firn [Parses org-files into data structures with Orgize ], Logseq [OCaml & Angstrom, for the document parser ]), they're very helpful and have already a good org-mode parser - +## About the external program, you could just talk to the PANDOC guys (or Firn [Parses org-files into data structures with Orgize ], Logseq [OCaml & Angstrom, for the document parser ]), they're very helpful and have already a good org-mode parser ## Is it feasible to have this process of parsing org-roam following the LSP protocol? that would allow to be editor agnostic, and it would save the work to define the communication protocol and any other technical details. - # Notes -- "org-roam just wants to create backlinks" -- org-mode has many many files (377 lines in dired… including .elc files) -- If you want to create an index of all the org files using the native format, it would be very slow. So org-roam uses a sqlite database -- ripgrep (written in Rust) is more capable than grep; used by some Zettelkasten -- "Is there something we could do to import backlinks into org mode?" -- "We've always tried to have an experimental ground where we can track backlinks" - +- "org-roam just wants to create backlinks". +- org-mode has many many files (377 lines in dired… including + .elc files). +- If you want to create an index of all the org files using the native + format, it would be very slow. So org-roam uses a sqlite database. +- ripgrep (written in Rust) is more capable than grep; used by some + Zettelkasten implementations. +- "Is there something we could do to import backlinks into Org mode?" +- "We've always tried to have an experimental ground where we can track backlinks" diff --git a/2020/info/19.md b/2020/info/19.md index cbba4c62..9260db46 100644 --- a/2020/info/19.md +++ b/2020/info/19.md @@ -18,24 +18,25 @@ Org-mode. I think, in all, this can quite easily cover a 10 minute window. +- + -- Actual start and end time (EST): Start 2020-11-28T16.02.37; End 2020-11-28T16.10.30; -- +- Actual start and end time (EST): Start: 2020-11-28T16.02.37; End: + 2020-11-28T16.10.30; # Questions - ## How do you keep doc/README.org in-sync with org-webring.el? +I use an exporter in the .org file that outputs the MD file on save +automatically. The relevant parts are at the bottom of the .org file. -I use an exporter in the .org file that outputs the MD file on save automatically. The relevant parts are at the bottom of the .org file. -- I saw that :). I was wondering about the synchronisation between the .org file and the .el file - - – that is done manually Currently. I wish there was an Easier way. There should be a way to export public definition DocStrings. - +- I saw that :). I was wondering about the synchronisation between the + .org file and the .el file. + - – that is done manually Currently. I wish there was an + Easier way. There should be a way to export public definition + DocStrings. # Notes - - - -Any more questions on org-webring, email - +- +- Any more questions on org-webring, email . diff --git a/2020/info/20.md b/2020/info/20.md index fa6a6211..c426572c 100644 --- a/2020/info/20.md +++ b/2020/info/20.md @@ -19,30 +19,31 @@ within this solution, and invite people to throw fruit^11^dhelp draw conclusions, ask questions, and discuss. [[!inline pages="internal(2020/info/dm-notes)" raw="yes"]] - -- Actual start and end time (EST): Start 2020-11-28T16.17.32; Q&A 2020-11-28T16.34; End: 2020-11-28T16.38.32 + +- Actual start and end time (EST): Start: 2020-11-28T16.17.32; Q&A: + 2020-11-28T16.34; End: 2020-11-28T16.38.32 # Questions - ## How is your background work? - See 06: Trivial Emacs Kits's Q&A: Corwin uses Wallpaper Engine. -- [Corwin] Wallpaper Engine on Steam is probably the thing that's grabbing attention. I haven't tried it under GNU/Linux. My family are (mostly) Windows users right now ****heavy sigh**** I don't want to get into my tool chain a huge amount, but I will talk about it some as/durning the Welcome to the Dungeon talk tomorrow. For now I will say I'm using a mix of free (free and not-free but too easy to avoid tools on my one pretty good computer). I would love to have the time to invest to use more (only) free stuff but sometimes we we can't afford the freedom, in terms of the learning curve. I think this is the most important problem space in free software, FWIW. - +- [Corwin] Wallpaper Engine on Steam is probably the thing that's + grabbing attention. I haven't tried it under GNU/Linux. My family + are (mostly) Windows users right now ****heavy sigh**** I don't want + to get into my tool chain a huge amount, but I will talk about it + some as/durning the Welcome to the Dungeon talk tomorrow. For now I + will say I'm using a mix of free (free and not-free but too easy to + avoid tools on my one pretty good computer). I would love to have + the time to invest to use more (only) free stuff but sometimes we we + can't afford the freedom, in terms of the learning curve. I think + this is the most important problem space in free software, FWIW. ## What was the key message you wanted to share with your talk? - Macros are powerful and necessary. Consider how you use them? - ## Do you mind if I use your macro code as inspiration for an elisp uglifier? - -Have At! It's GPLv3 and you are welcome; lmk if you have any trouble finding fruit to throw - - - - +Have At! It's GPLv3 and you are welcome; let me know if you have any +trouble finding fruit to throw. -- cgit v1.2.3