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.

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

Initial version of glTF spec in asciidoctor format #1901

Merged
merged 62 commits into from
Sep 23, 2021
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
10e7b3a
Initial rough cut
oddhack Nov 10, 2020
1a56109
Clean up tables
oddhack Nov 10, 2020
69cc009
Fix format of http links.
oddhack Nov 11, 2020
1ed0a8e
Fix internal xrefs and a couple of http: URLs to https: where possible
oddhack Nov 11, 2020
e7f69b8
minor formatting cleanup
oddhack Nov 11, 2020
ea1775e
Replace a couple of link references with the master glTF branch in
oddhack Nov 11, 2020
46943e9
Math test
oddhack Nov 11, 2020
b48ec6a
Minor cleanups for remote image: URLs, Greek characters, and a few
oddhack Nov 12, 2020
c35b9d8
Initial cut at a working asciidoctor version of the glTF spec. Includes
oddhack Nov 13, 2020
1052a8f
Should include the single spec source markup, not generated output
oddhack Nov 13, 2020
a8c7229
Remove test math markup per Ed
oddhack Nov 13, 2020
afc659d
Updated Makefile to work with new wetzel, per
oddhack Nov 15, 2020
1c3bb69
Merge remote-tracking branch 'origin/master' into jon-adoc
emackey Nov 17, 2020
0d27971
Merge changes from https://github.com/KhronosGroup/glTF/pull/1749
emackey Nov 17, 2020
da2c098
Update generated files from current wetzel repo
oddhack Nov 18, 2020
6f2dc0e
Add missing [appendix] tags so they get appendix letters, not chapter…
oddhack Nov 19, 2020
4580781
Remove the generated SingleSpec.adoc target, since we've decided not to
oddhack Nov 20, 2020
8dbd8e3
Remove checked-in generated target.
oddhack Nov 20, 2020
e05fc82
Run in right directory
oddhack Nov 20, 2020
4489751
Attempt to store generated HTML
oddhack Nov 20, 2020
5c1b8de
Build both HTML and PDF targets
oddhack Nov 20, 2020
90e5136
Rename spec source and refactor wetzel action in Makefile
oddhack Nov 20, 2020
a80a276
Merge remote-tracking branch 'origin/master' into jon-adoc
emackey Nov 23, 2020
23bfb8c
Merge remote-tracking branch 'origin/master' into jon-adoc
emackey Nov 23, 2020
87cb6b0
Add JSON schemas to AsciiDoctor output.
emackey Nov 24, 2020
7d0f07f
Add the words PREVIEW DRAFT since this is not final yet.
emackey Nov 24, 2020
90751fb
Merge pull request #1907 from KhronosGroup/ed-adoc-embed
oddhack Nov 24, 2020
a44dc1b
Minor Makefile cleanup for new generated target
oddhack Nov 24, 2020
0aeb27a
Lock version of wetzel
emackey Nov 24, 2020
fbdde31
This modifies the Asciidoctor HTML & PDF specs to compare asciidoctor
oddhack Nov 28, 2020
3702605
Remove old math formatting leaving just latexmath
oddhack Dec 2, 2020
b2c9f74
Merge pull request #1909 from KhronosGroup/stem-math
oddhack Dec 2, 2020
b3dc81f
Fix two citations. The Burley2012 reference was a dead link to a cloud
oddhack Dec 2, 2020
6c6ef27
Merge branch 'jon-adoc' of github.com:KhronosGroup/glTF into jon-adoc
oddhack Dec 2, 2020
4458c7a
Merge branch 'master' into jon-adoc
oddhack Dec 2, 2020
fdea3da
Sectioned all hanging text.
RealismCloud Dec 2, 2020
a8598f6
Minor labeling changes
RealismCloud Dec 2, 2020
a151b9e
Merge pull request #1917 from DrX3D/jon-adoc
emackey Dec 3, 2020
6944dd3
Merge remote-tracking branch 'origin/master' into jon-adoc
emackey Dec 3, 2020
e1ea8f6
Move copyright to top and credits to bottom.
emackey Dec 3, 2020
c772244
Put glTF logo on PDF title page
oddhack Dec 3, 2020
11fd09e
Merge branch 'jon-adoc' of github.com:KhronosGroup/glTF into jon-adoc
oddhack Dec 3, 2020
d78e65b
Merge pull request #1919 from KhronosGroup/reorg-adoc
emackey Dec 3, 2020
9d514db
Upgrade to [email protected] for subtler checkmarks.
emackey Dec 3, 2020
d8b8b9a
Use a specific FontAwesome checkmark for "required."
emackey Dec 3, 2020
7420e21
Linkify member agreement in the spec license
oddhack Dec 18, 2020
94ed681
Update normative language (#1997)
lexaknyazev Jul 20, 2021
522d506
Emissive note: Markdown -> AsciiDoc tweak
emackey Jul 20, 2021
8e6aa7d
Minor language adjustments
lexaknyazev Jul 29, 2021
bb537b3
Add the **MUST** keyword to wetzel's output (#2014)
emackey Aug 16, 2021
7fbcc52
More language updates (#2012)
lexaknyazev Aug 16, 2021
061997b
Update Motivation and Design Goals
lexaknyazev Aug 20, 2021
45b308e
Merge remote-tracking branch 'origin/master' into jon-adoc
emackey Sep 13, 2021
839ca79
Merge to adoc the change from PR #2022 (#2024)
emackey Sep 13, 2021
7748663
Integrate latest AsciiDoc updates (#2028)
lexaknyazev Sep 22, 2021
4399139
Clarify morphed attribute formats & cleanup indexed semantics (#2030)
lexaknyazev Sep 22, 2021
ac0d679
Update PBR links
lexaknyazev Sep 23, 2021
9757259
Use generated version info (#2032)
lexaknyazev Sep 23, 2021
e2bd348
Use draft/2020-12 schemas (#2031)
lexaknyazev Sep 23, 2021
5d3dfa4
Add REUSE license checker and CI check to new glTF 2.0 branch (#2029)
oddhack Sep 23, 2021
2326f4b
Merge branch 'master' into jon-adoc
lexaknyazev Sep 23, 2021
3e249b3
Add GitHub-specific note
lexaknyazev Sep 23, 2021
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
63 changes: 63 additions & 0 deletions specification/2.0/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Copyright 2020 The Khronos Group Inc.
# SPDX-License-Identifier: Apache-2.0

# Output specification targets
all: allhtml allpdf

allhtml: README.html SingleSpec.html

allpdf: README.pdf SingleSpec.pdf

# Generate the Properties Reference section of the spec from JSON schema.
# This assumes the 'wetzel' repository is cloned in a directory parallel
# to the glTF repository.
WETZELROOT = ../../../wetzel
WETZEL = $(WETZELROOT)/bin/wetzel.js
# Base name of the generated properties reference file
PROPREF = PropertiesReference
$(PROPREF).adoc: $(WETZEL) $(wildcard schema/*.json)
$(WETZEL) -l2 -a=cqo -m=a -p schema \
emackey marked this conversation as resolved.
Show resolved Hide resolved
-i '["gltfchildofrootproperty.schema.json", "gltfid.schema.json", "gltfproperty.schema.json"]' \
schema/glTF.schema.json > $@

# Spec targets for offline generation
# Requires an up-to-date asciidoctor and asciidoctor-pdf be installed
# Recommended to use the khronosgroup/vulkan-docs-base Docker image
ASCIIDOCTOR = asciidoctor
SPECDEPS = README.adoc PropertiesReference.adoc

README.html: $(SPECDEPS)
$(ASCIIDOCTOR) -b html5 README.adoc -o $@

# :allow-url-read: is necessary for the imbedded render.githubusers.com
# math images to be processed for the PDF target. See
# https://github.com/asciidoctor/asciidoctor-pdf/issues/369
README.pdf: $(SPECDEPS)
$(ASCIIDOCTOR) -b pdf -a allow-uri-read -r asciidoctor-pdf README.adoc -o $@

# Generate a full single-file spec source by merging
# PropertiesReference.adoc into README.adoc at the point it would
# otherwise be included by asciidoctor. This is a horrid workaround for
# the problem that github's asciidoctor implementation does not support
# the include:: directive.

SINGLESPEC = SingleSpec.adoc

$(SINGLESPEC): $(SPECDEPS)
sed -e "/include::$(PROPREF).adoc/r$(PROPREF).adoc" \
-e "/include::$(PROPREF).adoc/d" < README.adoc > $@

# HTML and PDF targets for the single-file spec source. Should be
# identical to the README outputs - this is intended only for github
# consumption.

SingleSpec.html: SingleSpec.adoc
$(ASCIIDOCTOR) -b html5 $? -o $@

SingleSpec.pdf: SingleSpec.adoc
$(ASCIIDOCTOR) -b pdf -a allow-uri-read -r asciidoctor-pdf $? -o $@


GENERATED = $(PROPREF).adoc $(SINGLESPEC)
clean:
-rm -f $(GENERATED)
Loading