Not to be too picky, but I found this confusing. Is there a prior tutorial that covers some of this (things like @settings trees within documents) that should be completed before the rst3 tutorial? What is the required knowledge level of your target audience for this tutorial?
Are you assuming a person with little or no knowledge about Leo going through this tutorial or are there prerequisites? If there are prerequisites, would it not make sense to detail them at the beginning? Something like "Someone going through this tutorial should have a basic idea about (concept x) and have completed (tutorial Q). What is blindingly obvious to you may not be so obvious to someone else. If the rst3 tutorial is part of a hierarchy of concepts, where does it fit? Another example: Does the rst3_call_docutils setting go in the node or the body? If I have zero experience with the @settings tree in a .leo document (only having met the idea in relation to the two settings files), this becomes a question in my mind. I am currently working with my son to learn python. We are going through a tutorial and they are very cognizant of these issues. Concepts are not used to support other concepts unless they have been covered first. A "Python for Non-Programmers" tutorial has to take into account the fact that the target audience is starting from zero. I guess an alternative approach would be to provide direct pop-up links to the documentation for items like @settings so that people who have never run across the idea can get up to speed quick before proceeding with the tutorial.. Put the rst3_call_docutils setting in the @settings tree in the .leo file containing the @rst node. Chris On Sat, Nov 2, 2013 at 4:11 AM, Edward K. Ream <[email protected]> wrote: > On Fri, Nov 1, 2013 at 3:28 PM, Matt Wilkie <[email protected]> wrote: > >> >> Could the rst tutorial be enhanced by providing samples of input and >>> output? >> >> >> see >> https://github.com/leo-editor/snippets/tree/master/examples/rst-tutorial: >> rst-tutorial-example.leo >> leo-rst-tutorial-example.png >> myDocument.html >> myDocument.html.txt >> > > Interesting idea. Imo, the tutorial isn't the right place for these: we > want the tutorial to be as short as possible. > > CheatSheet.leo > > seems for promising. Imo, myDocument.html.txt is the important file: it > shows the output of the rst3 command, before being sent to docutils or > sphinx. > > Rev 6221 now shows the contents of the intermediate file, > ~/myDocument.html.txt as part of the rst3 tutorial section, along with some > new words in the introductory (top-level) node. > > 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 [email protected]. > To post to this group, send email to [email protected]. > Visit this group at http://groups.google.com/group/leo-editor. > For more options, visit https://groups.google.com/groups/opt_out. > -- 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 [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/leo-editor. For more options, visit https://groups.google.com/groups/opt_out.
