Re: Discuss: The design of Leo's support for AsciiDoctor
On Wed, May 15, 2019 at 2:37 PM Matt Wilkie wrote: > Disambiguation: there is AsciiDoc the format specification and original > python tool/library implementation, and AsciiDoctor the ruby tool/library. > AsciiDoctor is basically a super-successful fork of asciidoc. > >- py2 - https://github.com/asciidoc/asciidoc >- py3 - https://github.com/asciidoc/asciidoc-py3 >- Dr - https://asciidoctor.org/ >- diff from Dr point of view: >https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/ > > Thanks for these links. I am using the Ruby version of asciidoctor for prototyping. I didn't know about the py3 lib, but I don't think it's necessary for now. The new adoc command just creates a .adoc file. What we do with that is up to us, but using the official (ruby) version of AsciiDoctor seems simple and good. My next step will be to prototype the conversion of Leo's docs to AD. This will have several parts: - Some trial conversions of @rst trees to @adoc trees. - Automate the conversion of the .adoc files to .html. - Experiments with themes, .css, etc. Edward -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/CAMF8tS3nE02QrtB2gDGqRaOt8y_w0t31dWn7g5Pr9x9VvZ338w%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
Re: Discuss: The design of Leo's support for AsciiDoctor
> > I'm learning as I write. At this point I don't know what the aims of py3 > are vis a vis Dr (ie: do they hope to be python equivalent or are they > oriented to different end goals?) > https://github.com/asciidoc/asciidoc-py3/issues/67 -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/effea69c-f435-41e9-b12e-d7917abd293b%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
Re: Discuss: The design of Leo's support for AsciiDoctor
Disambiguation: there is AsciiDoc the format specification and original python tool/library implementation, and AsciiDoctor the ruby tool/library. AsciiDoctor is basically a super-successful fork of asciidoc. - py2 - https://github.com/asciidoc/asciidoc - py3 - https://github.com/asciidoc/asciidoc-py3 - Dr - https://asciidoctor.org/ - diff from Dr point of view: https://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/ I'm learning as I write. At this point I don't know what the aims of py3 are vis a vis Dr (ie: do they hope to be python equivalent or are they oriented to different end goals?) -matt -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/1f563cf9-2579-4d01-a27b-058d2fe67a30%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
Re: First light for the adoc command
On Wednesday, May 15, 2019 at 11:41:12 AM UTC-5, Edward K. Ream wrote: The code should scan the root node looking for the regex "^=" > Done at rev 9bd84b. Edward -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/95b77482-3c7b-4f4c-a1c3-70d6ba39fbba%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
Re: First light for the adoc command
On Wednesday, May 15, 2019 at 11:41:12 AM UTC-5, Edward K. Ream wrote: > The present code does not handle file encodings. None are needed. AD handles only utf-8 or utf-16 encoded files, which saves a lot of bother. Edward -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/7f4c3c05-e872-4d3e-a72a-f553e5cc10f8%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
First light for the adoc command
Rev a9b0aa in devel demonstrates Leo's new adoc command. It converts an @adoc tree to AsciiDoctor sources. All parts of this code are experimental, and subject to change. The @adoc node should have the form: `@adoc x.adoc`. Relative file names are assumed relative to c.frame.openDirectory. After running the command, you must use the asciidoctor command to convert the x.adoc to x.html. *Notes* At present, the adoc command assumes the root @adoc node will define a top-level heading. Instead, the code should scan the root node looking for the regex "^=", and adjust heading levels accordingly. That's next. The new code is in leo/core/leoAsciiDoctor.py. I see no need to make it a plugin. The new code is a tiny fraction of the rst3 code, and completely separate from it. The code handles no options whatever. It also doesn't handle various accreted features. I intend keep this code simple. The present code does not handle file encodings. There may be AsciiDoctor setting that pertains to this. *Summary* The adoc command does not automatically call AsciiDoctor. The adoc command is experimental. Everything is subject to change. At present, no setting (anywhere) affect the adoc command. All comments and suggestions are welcome. Edward -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/9779e3af-2686-4d15-be93-337ced84ac92%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
Re: discuss: Use markdown for Leo's documentation #1147
It seems to me that moving from rst to asciidoc for documentation in Leo is a good move. It adds features and provides a stable path into the future. Rst seems to have "lost" to markdown in the quick and easy markup space. But markdown seems to still be somewhat of a moving target. I don't see any barriers to providing the same sort of support to the pandoc specific version of markdown as it exists today via a mechanism similar to the rst3 command if someone wanted to write that. But knowing that the specification and the prerequisites for support via Leo will always be subject to change seems to be a bit of a buzz kill for that. And it remains to be seen which flavor of markdown is going to ultimately win in the race to a specification. When I first came to Leo I taught myself to use rst. I have since added tools to that from the python toolkit that support it. I use nikola to build my static website, for example, and it happily gobbles up all of the rst I can throw at it. All of my organization and templating is done using Leo and its abbreviations. Inertia being what it is I will probably continue to use rst for the forseeable future, simply because it exceeds my requirements for blogging and writing fiction. So I don't really have a preference one way or another as I don't write documentation for Leo. Chris -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/6707d0f2-e9d5-4dcc-ba3a-d80f166ba3f7%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
Re: discuss: Use markdown for Leo's documentation #1147
On Tue, 14 May 2019 20:26:47 -0700 (PDT) Matt Wilkie wrote: > > > > > What I like about AsciiDoc is the code snippets support and the way > > it declares tables. But Pandoc can read ASCIIDoc [...] > > > > (?) This seems to be in the air or incomplete according to > https://github.com/jgm/pandoc/issues/1456. (From the ycombinator > thread, which by the way also highlights another consideration: > Asciidoc readability of nested lists in plain text is somewhat > compromised relative to Markdown.) The R software community and in particular the ~commercial RStudio front end are I think helping to drive the markdown -> pandoc pipeline, so it might be more mature / maintained than some other input formats for pandoc. Not really sure, seeing I haven't really used any other input formats. > I have generally high opinion of pandoc. It has saved me many hours > of frustration more than once. > > It's hard to install automatically on Windows (it's not just `pip > install pandoc`, last time I checked), but easier than AsciiDoctor > which is in Ruby. Sometimes I find conda, anaconda's package manager, usually installed via miniconda, works where pip doesn't, and visa versa. I think I've been able to install pandoc in Windows with conda, although I've been using Windows less, again, recently. Cheers -Terry > --matt > -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/20190515071451.7f354f51%40lakeview. For more options, visit https://groups.google.com/d/optout.
Discuss: The design of Leo's support for AsciiDoctor
I like Matt's "Discuss" prefix. It's apt here. This post will discuss how Leo can support AsciiDoctor (AD). This is *not *a discussion of... - Preferences. Leo will retain its support for rST. - The merits of AsciiDoctor. I'm convinced that Leo should support AD. - How Leonistas "should" write documentation. The choice is yours. *Explicit support is not actually needed* AsciiDoctor is text format, so Leo doesn't actually need any special support for AD. One could simply write AD text in an external file format created by @clean or @file. As I write this, I see that Leo should support @language ad/ascii_doctor, and syntax color AD, if pygments does not already do this. Using a "plain" external file does have benefits, especially automatic update of the outline when the external file changes. This way is always available to those who want it. Otoh, just putting AD text in a text file doesn't take full advantage of Leo's outline structure. Leo's rst3 command will, by default, create section headings *at the proper level*. That is, outline level determines the level of rST sections. *The design of the ad command* The ad command will be modeled on Leo's rst3 command. It will scan the given outline for one or more @ascii_doctor nodes, then write the contents of those trees to external files. By default, *headlines would become section titles*, so we need something like @ad-no-head, just as with the rst3 command. The ad command will be *much* simpler than the rst3 command: - AD syntax allows users to specify options, so there will be no need for so-called option @doc parts in bodies. - The rst3 command has complex code and user options telling how to deal with docutils. These will not be needed for ad command. - Unlike the rst3 command, the focus will be on the simplest thing that could possibly work. *Summary* Users could always write AD documentation in plain external files, but this would require specifying heading levels by hand. The ad command will be modeled on the rst3 command, but will be much simpler. I'll start writing this command today. Leo should support @language ascii_doctor and syntax color AD. Users will probably want to define an ad;; abbreviation that expands to ascii_doctor. All comments welcome. Edward -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/1cfa27be-7e1d-4a3a-a720-c7e7301862a1%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
Re: discuss: Use markdown for Leo's documentation #1147
On Tue, May 14, 2019 at 6:34 PM Offray Vladimir Luna Cárdenas < off...@riseup.net> wrote: > I agree on plain Markdown as a bad option for complex documentation, but > almost nobody uses plain Markdown for that but some superset of > CommonMark[1], as happens with Pandoc My next post will discuss the design of support for AsciiDoctor in Leo. Here, I'll just point out that such support will not inhibit the use of other tools such as PanDoc. Edward -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/CAMF8tS0cS%2Bc9MbD8Hb_9KwhPxcuLNNZLoRHpyNhE_XfEOvGw1A%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
Re: Status of LeoWapp
On Tue, May 14, 2019 at 6:06 PM Edward K. Ream wrote: #1146 has now been fixed. > This took several days. The actual fix was to set an ivar in Leo's core! Ultimately, the work was gratifying. LeoWapp now has standardized traces, and an old, forgotten, focus-related hack went away. So this is good. The code is getting simpler and more correct. Edward -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to leo-editor+unsubscr...@googlegroups.com. To post to this group, send email to leo-editor@googlegroups.com. Visit this group at https://groups.google.com/group/leo-editor. To view this discussion on the web visit https://groups.google.com/d/msgid/leo-editor/CAMF8tS25RudOEhT0-%2B9zv%3D6q392s-yGdc1_22vZxSV_CQ-mKYg%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
