reorganisation

cysouw · Mar 29, 2021 · 01a115e · 01a115e
1 parent b4d82ed
commit 01a115e
Show file tree

Hide file tree

Showing 17 changed files with 2 additions and 2 deletions.
diff --git a/tests/figure/ExampleStructure.png → docs/figure/ExampleStructure.png b/tests/figure/ExampleStructure.png → docs/figure/ExampleStructure.png
diff --git a/tests/langsci-gb4e.sty → docs/langsci-gb4e.sty b/tests/langsci-gb4e.sty → docs/langsci-gb4e.sty
diff --git a/tests/pandoc-ling-old.lua → docs/pandoc-ling-old.lua b/tests/pandoc-ling-old.lua → docs/pandoc-ling-old.lua
diff --git a/tests/processVerbatim.lua → docs/processVerbatim.lua b/tests/processVerbatim.lua → docs/processVerbatim.lua
diff --git a/tests/readme.docx → docs/readme.docx b/tests/readme.docx → docs/readme.docx
diff --git a/tests/readme.epub → docs/readme.epub b/tests/readme.epub → docs/readme.epub
diff --git a/tests/readme.html → docs/readme.html b/tests/readme.html → docs/readme.html
diff --git a/tests/readme_expex.pdf → docs/readme_expex.pdf b/tests/readme_expex.pdf → docs/readme_expex.pdf
diff --git a/tests/readme_expex.tex → docs/readme_expex.tex b/tests/readme_expex.tex → docs/readme_expex.tex
diff --git a/tests/readme_gb4e.pdf → docs/readme_gb4e.pdf b/tests/readme_gb4e.pdf → docs/readme_gb4e.pdf
diff --git a/tests/readme_gb4e.tex → docs/readme_gb4e.tex b/tests/readme_gb4e.tex → docs/readme_gb4e.tex
diff --git a/tests/readme_langsci-gb4e.pdf → docs/readme_langsci-gb4e.pdf b/tests/readme_langsci-gb4e.pdf → docs/readme_langsci-gb4e.pdf
diff --git a/tests/readme_langsci-gb4e.tex → docs/readme_langsci-gb4e.tex b/tests/readme_langsci-gb4e.tex → docs/readme_langsci-gb4e.tex
diff --git a/tests/readme_linguex.pdf → docs/readme_linguex.pdf b/tests/readme_linguex.pdf → docs/readme_linguex.pdf
diff --git a/tests/readme_linguex.tex → docs/readme_linguex.tex b/tests/readme_linguex.tex → docs/readme_linguex.tex
diff --git a/tests/test.sh → docs/test.sh b/tests/test.sh → docs/test.sh
diff --git a/readme.md b/readme.md
@@ -9,7 +9,7 @@ tl;dr
 - Easily write linguistic examples including basic interlinear glossing. 
 - Let numbering and cross-referencing be done for you. 
 - Export to (almost) any format of your wishes for final polishing.
-- As an example, check out this readme in [HTML](https://cysouw.github.io/tests/readme.html) or [Latex](https://cysouw.github.io/test/readme_gb4e.pdf).
+- As an example, check out this readme in [HTML](https://cysouw.github.io/readme.html) or [Latex](https://cysouw.github.io/readme_gb4e.pdf).
 
 # Rationale
 
@@ -219,7 +219,7 @@ Inspired by the `linguex`-approach, you can also use the keywords `next` or `las
 
 Referring to sub-examples can be done by manually adding a suffix into the cross reference, simply separated from the identifier by a space. For example, `[@lllast c]` will refer to the third sub-example of the last-but-two example. Formatted this will look like this: [@lllast c], smile! However, note that the "c" has to be manually determined. It is simply a literal suffix that will be copied into the cross-reference. Something like `[@last hA1l0]` will work also, leading to [@last hA1l0] when formatted (which is of course nonsensical).
 
-For exports that include attributes (like html), the examples have an explicit id of the form `exNUMBER` in which `NUMBER` is the actual number as given in the formatted output. This means that it is possible to refer to an example on any web-page by using the hash-mechanism to refer to a part of the web-page. For example `#ex4.7` at can be used to refer to the seventh example in the html-output of this readme (try [this link](https://cysouw.github.io/tests/readme.html#ex4.7)). The id in this example has a chapter number '4' because in the html conversion I have set the option `addChapterNumber` to `true`. (Note: when numbers restart the count in each chapter with the option `restartAtChapter`, then the id is of the form `exCHAPTER.NUMBER`. This is necessary to resolve clashing ids, as the same number might then be used in different chapters.)
+For exports that include attributes (like html), the examples have an explicit id of the form `exNUMBER` in which `NUMBER` is the actual number as given in the formatted output. This means that it is possible to refer to an example on any web-page by using the hash-mechanism to refer to a part of the web-page. For example `#ex4.7` at can be used to refer to the seventh example in the html-output of this readme (try [this link](https://cysouw.github.io/readme.html#ex4.7)). The id in this example has a chapter number '4' because in the html conversion I have set the option `addChapterNumber` to `true`. (Note: when numbers restart the count in each chapter with the option `restartAtChapter`, then the id is of the form `exCHAPTER.NUMBER`. This is necessary to resolve clashing ids, as the same number might then be used in different chapters.)
 
 I propose to use these ids also to refer to examples in citations when writing scholarly papers, e.g. (Cysouw 2021: #ex7), independent of whether the links actually resolve. In principle, such citations could easily be resolved when online publications are properly prepared. The same proposal could also work for other parts of research papers, for example using tags like `#sec, #fig, #tab, #eq` (see the Pandoc filter [`crossref-adapt](https://github.com/cysouw/crossref-adapt)). To refer to paragraphs (which should replace page numbers in a future of adaptive design), I propose to use no tag, but directly add the number to the hash (see the Pandoc filter [`count-para`](https://github.com/cysouw/count-para) for a practical mechanism to add such numbering).