PhilippeSigaud / Pegged

A Parsing Expression Grammar (PEG) module, using the D programming language.
534 stars 66 forks source link

Document order and generation #255

Open Aphexus opened 5 years ago

Aphexus commented 5 years ago

The wiki seems to give a list of the documents out of order(it is in alphabetical order)(this obviously makes it really difficult to read in the intended order as outlined by the docs)

Also, any way they could be printed to a single pdf? I used some online markdown converter and the combined them and it's a pretty nice read but they are all out of order.

Would be nice if it could be automated so when they change it is still valid.

veelo commented 5 years ago

I think the proper addressee would be GitHub, not this project. GitHub's wiki functionality is rather limited; I particularly miss the ability to search the content of GitHub wikis.

Wat you could try is fork the wiki, rename all pages of the tutorial with a prefix like 0n_ where n increases in order. If it works out well I think Philippe would be glad to pull. Alternatively, rename the title of https://github.com/PhilippeSigaud/Pegged/wiki/Pegged-Tutorial to move it up in the page list.

ghost commented 5 years ago

You should give up the wiki and make a GH page website using the markdown that's also in the sources tree. Both have to be synchronized anyway which tended to be neglected in the past (see #242 for example)

Aphexus commented 5 years ago

I basically did this for generating the pdf. I had several extra pdf's that did not fit(most of the pdf's refer to the next section but I guess some things are from older versions).

_Pegged.pdf 01 PEG-Basics.pdf 02 Declaring-a-Grammar.pdf 03 Using-a-Grammar.pdf 04 Memoization.pdf 05 Grammars-as-D-Modules.pdf 06 Grammar-Composition.pdf 07 Using-the-Parse-Tree.pdf 08 Tree-Decimation.pdf 09 Extended-PEG-Syntax.pdf 10 Parameterized-Rules.pdf 11 Semantic-Actions.pdf 12 Generating-Code.pdf 13 User-Defined-Parsers.pdf 14 Writing-Your-Own-Grammar.pdf 16 Optimizations.pdf 17 Grammar-Debugging.pdf 18 Grammar-Testing.pdf Four-Levels-of-Encapsulation.pdf Grammar-Examples.pdf Home.pdf Left-Recursion.pdf Parse-Result.pdf Parse-Trees.pdf Parsing-Levels.pdf Pegged-Tutorial.pdf Predefined-Parsers.pdf

veelo commented 5 years ago

You should give up the wiki and make a GH page website

That would be a better option in the long run, yes.

veelo commented 5 years ago

most of the pdf's refer to the next section but I guess some things are from older versions

I think the pages that are part of the tutorial form a sequence, but not all pages are part of the tutorial. Some parts of the text seem to be outdated, I agree.