lawrancej / compilerdesign Goto Github PK

When typed ./generate.sh check 05 is shows the problems with section 04.

Hyperlinks can easily become broken. We need a script to show which hyperlinks in which files are broken. Since we want fragments to work properly, this isn't something that curl or wget can do for us.

Is there a way to add pictures to the textbook? I would like to make charts and some tables to explain NFA to DFA, but at the moment I can not find a good way to add them in.

Dibs.

We should reconsider using vectors for our image renders and move to a more universally supported raster such a .jpg or .png. The .svg files are sufficient for designing the graphics but should be rendered to a separate format for use throughout the documentation. You would be hard pressed to find a browser that does not support .png rasters out of the box in this day and age. Otherwise we restrict users to a very select few markdown parsers and must assume they have the correct extensions for the engine installed. (I think this counter-intuitive to our cross platform mindset. (I am assuming we want this to be cross-platform))

Something else to bare in mind. If we are going to split the images into a development and production version our hierarchy should replace that. Maybe Images/Raw or Images/Source for the svg, psd, or any other internal development format and then Images/Raster for rendered .png.

I can implement this change and render the .svg to png and update the markdown links if you would like.

Wrong section, I apologize.

Unaswered question:

Paraphrased from wikipedia for answer: Compiler optimization that replaces a function call with the body of the caller(i'm not very sure what this part means). This optimization may improve time and space usage when ran, but might make the program bigger.

• Check grammar/spelling automatically
• Avoid weasel words
• use diction

Add in TODOs for each of the uncovered topics in Unit 2 inside CourseMappingCS304.xls

See http://johnmacfarlane.net/pandoc/epub.html for an example.

Pretty much just a copy/paste from index.md into all the chapter files. The labels/names are already correct.

The Saylor Foundation is offering a $20,000 prize for a CC-BY compiler design textbook.

• The textbook must cover these topics: http://www.saylor.org/content/coursemapping/CourseMappingFormCS304.xls
• Their criteria are here: http://www.saylor.org/open-textbook-challenge-peer-review-criteria/

This is a meta-issue. Open up http://www.saylor.org/content/coursemapping/CourseMappingFormCS304.xls and create issues for these sections.

Add in TODOs for each of the uncovered topics in Unit 1 inside CourseMappingCS304.xls

Fix them

Add in TODOs for each of the uncovered topics in Unit 3 inside CourseMappingCS304.xls

Run ./check.sh all to find writing issues in your section. Add the section number at the end.

For example:

./check.sh all 04 to find all writing issues in section 04.

A unicode character somewhere in the textbook is preventing pandoc from generating. Unfortunately, pandoc is not very verbose and does not give any more detail.