Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switching from Madoko to AsciiDoc for PNA specification #128

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Switching from Madoko to AsciiDoc for PNA specification #128

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8bae985
Switching from Madoko to AsciiDoc for PNA specification
Dscano Nov 23, 2024
872f2dc
PDF first draft
Dscano Nov 24, 2024
49b7fee
Addressed comments and fix include
Dscano Nov 25, 2024
a83abc6
Final implementation
Dscano Dec 1, 2024
278d14a
Address comments from the first round of reviews.
Dscano Dec 29, 2024
26abba9
Removed appendix
Dscano Jan 2, 2025
1a3a92f
Add HTML file to Makefile
Dscano Jan 4, 2025
ee0fbeb
Remove p4.json
Dscano Jan 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
SPEC=PNA
ROUGE_STYLE=github

all: build/${SPEC}.pdf
all: ${SPEC}.pdf

build/${SPEC}.pdf: ${SPEC}.mdk
madoko --pdf -vv --png --odir=build $<

build/${SPEC}.pdf: p4.json
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the p4.json file should be removed with this PR, unless you find some reference to that file in the files that remain. I think p4.json was only used for Madoko syntax highlighting.

build/${SPEC}.pdf: pna.p4
${SPEC}.pdf: ${SPEC}.adoc
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add the file pna.p4 as a dependency on this rule, and the rule for generating HTML output, since PNA.adoc has include directives that include portions of pna.p4. If pna.p4 changes, it is likely that the PDF and/or HTML files need to be updated, too.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, please add a Makefile rule to generate HTML output. I don't see one here. It would be helpful to have that, even if the original Makefile did not have such a rule to generate HTML from Madoko source.

time asciidoctor-pdf -v \
-r asciidoctor-mathematical \
-r asciidoctor-bibtex \
-a pdf-fontsdir=resources/fonts \
-a rouge-style=$(ROUGE_STYLE) $<

clean:
${RM} -rf build
/bin/rm -f ${SPEC}.pdf

P4C=p4test
#P4C=p4test --Wdisable=uninitialized_out_param
Expand Down
Loading