From cc85aae3617c620eeebb1e6c4452f94d1dd13da8 Mon Sep 17 00:00:00 2001 From: Neel Smith Date: Fri, 12 Apr 2024 16:15:17 -0400 Subject: [PATCH 1/4] Touch up pages --- quarto/_quarto.yml | 4 ++++ quarto/guides/index.qmd | 9 ++++++++- quarto/index.qmd | 2 ++ 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/quarto/_quarto.yml b/quarto/_quarto.yml index 5b9ea3a..7745519 100644 --- a/quarto/_quarto.yml +++ b/quarto/_quarto.yml @@ -26,6 +26,7 @@ website: - text: "Guides" file: guides/index.qmd + - text: "Reference" file: reference/index.qmd - text: "Acknowledgments" @@ -43,6 +44,7 @@ website: - title: "Tutorials" contents: - tutorials/index.qmd + - text: "---" - tutorials/validation.qmd - tutorials/tokenization.qmd - tutorials/corpora.qmd @@ -50,12 +52,14 @@ website: - title: "Guides" contents: - guides/index.qmd + - text: "---" - guides/tokenization-guide.qmd - guides/diyortho.qmd - title: "Reference" contents: - reference/index.qmd + - text: "---" - reference/implementations.qmd diff --git a/quarto/guides/index.qmd b/quarto/guides/index.qmd index b7b1a79..24f25b4 100644 --- a/quarto/guides/index.qmd +++ b/quarto/guides/index.qmd @@ -2,4 +2,11 @@ title: "Guides" --- -Recipe book for working with `Orthography.jl` +If you're just getting started with `Orthography.jl`, + +:::{.callout-warning} + +Recipes for working with the `Orthography.jl` package. +::: + + diff --git a/quarto/index.qmd b/quarto/index.qmd index 2ac3c6f..b224af4 100644 --- a/quarto/index.qmd +++ b/quarto/index.qmd @@ -8,3 +8,5 @@ This site introduces the conceptual model of orthography developed over several It also includes documentation of `Orthography.jl`, a Julia package that implements the MID model of orthography. `Orthography.jl` supports working with editions of digital texts adhering to a specified orthography. + +> Find more of my digital scholarship [here](https://neelsmith.quarto.pub/digschol/). \ No newline at end of file From 3340fe5f882f5bf954e342ff93ccf3d9cd7bb169 Mon Sep 17 00:00:00 2001 From: Neel Smith Date: Sat, 13 Apr 2024 09:17:43 -0400 Subject: [PATCH 2/4] Rephrase --- quarto/_quarto.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quarto/_quarto.yml b/quarto/_quarto.yml index 7745519..3728bb6 100644 --- a/quarto/_quarto.yml +++ b/quarto/_quarto.yml @@ -5,7 +5,7 @@ theme: spacelab execute: freeze: auto date: last-modified -margin-header: "⚠️ *Draft release.*" +margin-header: "⚠️ *Draft documentation.*" format: html: toc: true From 0327333dce5e8a5e32b74bfa991e7c716a939801 Mon Sep 17 00:00:00 2001 From: Neel Smith Date: Fri, 7 Jun 2024 09:59:37 -0400 Subject: [PATCH 3/4] Move docs to quarto --- docs/make.jl | 7 +--- docs/src/index.md | 2 +- quarto/_quarto.yml | 12 ++++++- quarto/index.qmd | 3 -- quarto/reference/apis.qmd | 62 ++++++++++++++++++++++++++++++++++ quarto/reference/internals.qmd | 24 +++++++++++++ 6 files changed, 99 insertions(+), 11 deletions(-) create mode 100644 quarto/reference/apis.qmd create mode 100644 quarto/reference/internals.qmd diff --git a/docs/make.jl b/docs/make.jl index 7ccc572..08886b6 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -17,12 +17,7 @@ makedocs( sitename = "Orthography", pages = [ "Orthography.jl" => "index.md", - - "API documentation" => [ - "man/index.md", - "man/internals.md" - ] - ] + ] ) deploydocs( diff --git a/docs/src/index.md b/docs/src/index.md index 64c54ee..f2a7a99 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,4 +1,4 @@ # Orthography -Learn the package on quarto.pub. See API docs here. \ No newline at end of file +Documentation has moved to [quarto.pub](https://neelsmith.quarto.pub/orthography/). \ No newline at end of file diff --git a/quarto/_quarto.yml b/quarto/_quarto.yml index 3728bb6..27a7e6e 100644 --- a/quarto/_quarto.yml +++ b/quarto/_quarto.yml @@ -5,7 +5,7 @@ theme: spacelab execute: freeze: auto date: last-modified -margin-header: "⚠️ *Draft documentation.*" +margin-header: "⚠️ *Draft documentation in progress:*
Package version `0.22.0`." format: html: toc: true @@ -35,6 +35,13 @@ website: - icon: github href: https://github.com/hcmid/Orthography.jl aria-label: GitHub + - icon: person-circle + menu: + - text: "About me" + href: https://neelsmith.quarto.pub + - text: "More of my digital scholarship" + href: https://neelsmith.quarto.pub/digschol/ + aria-label: "More of my work" sidebar: - title: "Concepts" @@ -59,11 +66,14 @@ website: - title: "Reference" contents: - reference/index.qmd + - reference/apis.qmd + - reference/internals.qmd - text: "---" - reference/implementations.qmd + - title: "Home" diff --git a/quarto/index.qmd b/quarto/index.qmd index b224af4..1e59f9d 100644 --- a/quarto/index.qmd +++ b/quarto/index.qmd @@ -7,6 +7,3 @@ This site introduces the conceptual model of orthography developed over several It also includes documentation of `Orthography.jl`, a Julia package that implements the MID model of orthography. `Orthography.jl` supports working with editions of digital texts adhering to a specified orthography. - - -> Find more of my digital scholarship [here](https://neelsmith.quarto.pub/digschol/). \ No newline at end of file diff --git a/quarto/reference/apis.qmd b/quarto/reference/apis.qmd new file mode 100644 index 0000000..8c9325f --- /dev/null +++ b/quarto/reference/apis.qmd @@ -0,0 +1,62 @@ +# API documentation: exported types and functions + +## Types + + +`OrthographicSystem` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +using Orthography +@doc OrthographicSystem +``` +::: + +`TokenCategory` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc TokenCategory +``` +::: + +LexicalToken +NumericToken +PunctuationToken +``` + +## Functions + +Public functions implemented for all subtypes of `OrthographicSystem`. + +```@docs +codepoints +tokentypes +validcp +validstring +tokenize +``` +Working with text corpora: + +```@docs +corpus_histo + +``` + +Other utilities + +```@docs +nfkc +``` + +## Example implementation + +```@docs +SimpleAscii +simpleAscii +``` + diff --git a/quarto/reference/internals.qmd b/quarto/reference/internals.qmd new file mode 100644 index 0000000..c1cb86f --- /dev/null +++ b/quarto/reference/internals.qmd @@ -0,0 +1,24 @@ +# API documentation: internals + +## Generic utility functions + +```@docs +Orthography.collecttail +Orthography.trimtail +``` + +## Functions supporting the `SimpleAscii` implementation + +```@docs +Orthography.asciialphabetic +Orthography.asciinumeric +Orthography.asciipunctuation +Orthography.asciiwhitespace +Orthography.asciiCPs +Orthography.basicTypes +Orthography.splitAsciiPunctuation +Orthography.asciitokenforstring +Orthography.isAsciiAlphabetic +Orthography.isAsciiPunctuation +Orthography.isAsciiNumeric +``` From 0a8ce93b8ee40c85df6362d3fc0b30606b2335e8 Mon Sep 17 00:00:00 2001 From: Neel Smith Date: Fri, 7 Jun 2024 10:07:52 -0400 Subject: [PATCH 4/4] Update docs --- quarto/_quarto.yml | 5 +- quarto/reference/apis.qmd | 137 +++++++++++++++++++++++---- quarto/reference/implementations.qmd | 12 --- quarto/reference/index.qmd | 17 +++- quarto/reference/internals.qmd | 105 +++++++++++++++++++- 5 files changed, 241 insertions(+), 35 deletions(-) delete mode 100644 quarto/reference/implementations.qmd diff --git a/quarto/_quarto.yml b/quarto/_quarto.yml index 27a7e6e..9ec22e7 100644 --- a/quarto/_quarto.yml +++ b/quarto/_quarto.yml @@ -68,9 +68,8 @@ website: - reference/index.qmd - reference/apis.qmd - reference/internals.qmd - - text: "---" - - reference/implementations.qmd - + + diff --git a/quarto/reference/apis.qmd b/quarto/reference/apis.qmd index 8c9325f..79a640b 100644 --- a/quarto/reference/apis.qmd +++ b/quarto/reference/apis.qmd @@ -1,4 +1,4 @@ -# API documentation: exported types and functions +# Exported types and functions ## Types @@ -24,39 +24,142 @@ using Orthography ``` ::: -LexicalToken -NumericToken -PunctuationToken +`LexicalToken` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc LexicalToken +``` +::: + + +`NumericToken` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc NumericToken +``` +::: + + +`PunctuationToken` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc PunctuationToken ``` +::: ## Functions Public functions implemented for all subtypes of `OrthographicSystem`. -```@docs -codepoints -tokentypes -validcp -validstring -tokenize + + +`codepoints` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc PunctuationToken +``` +::: + + +`tokentypes` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc tokentypes +``` +::: + +`validcp` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc validcp ``` +::: + +`validstring` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc validstring +``` +::: + +`tokenize` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc tokenize +``` +::: + Working with text corpora: -```@docs -corpus_histo + +`corpus_histo` +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc corpus_histo ``` +::: Other utilities -```@docs -nfkc + +`nfkc` + + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc nfkc ``` +::: ## Example implementation -```@docs -SimpleAscii -simpleAscii + +`SimpleAscii` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc SimpleAscii ``` +::: + +`simpleAscii` + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc simpleAscii +``` +::: diff --git a/quarto/reference/implementations.qmd b/quarto/reference/implementations.qmd deleted file mode 100644 index 0653671..0000000 --- a/quarto/reference/implementations.qmd +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Implementations" ---- - -The following Julia packages available from the Julia central registry implement one or more concrete subtypes of the `OrthographicSystem` abstraction. - -- `LatinOrthography.jl` -- `PolytonicGreek.jl` -- `ManuscriptOrthography.jl` (Greek) -- `AtticGreek.jl` -- `Lycian.jl` -- `BiblicalHebrew.jl` diff --git a/quarto/reference/index.qmd b/quarto/reference/index.qmd index 5f3d37a..2681f2f 100644 --- a/quarto/reference/index.qmd +++ b/quarto/reference/index.qmd @@ -3,4 +3,19 @@ title: Reference --- -Current API docs for the `Orthography.jl` package are on github at [https://hcmid.github.io/Orthography.jl/stable/](https://hcmid.github.io/Orthography.jl/stable/). \ No newline at end of file +## API documentation + +- [exported types and functions](./apis.qmd) +- [internal functions](./internals.qmd) + +## Implementations + +The following Julia packages available from the Julia central registry implement one or more concrete subtypes of the `OrthographicSystem` abstraction. + +- `LatinOrthography.jl` +- `PolytonicGreek.jl` +- `ManuscriptOrthography.jl` (Greek) +- `GreekScientificOrthography.jl` +- `AtticGreek.jl` +- `Lycian.jl` +- `BiblicalHebrew.jl` diff --git a/quarto/reference/internals.qmd b/quarto/reference/internals.qmd index c1cb86f..9fa74a5 100644 --- a/quarto/reference/internals.qmd +++ b/quarto/reference/internals.qmd @@ -1,4 +1,4 @@ -# API documentation: internals +# Internal functions ## Generic utility functions @@ -9,16 +9,117 @@ Orthography.trimtail ## Functions supporting the `SimpleAscii` implementation -```@docs + Orthography.asciialphabetic + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +using Orthography +@doc OrthographicSystem +``` +::: + Orthography.asciinumeric + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem +``` +::: + Orthography.asciipunctuation + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem +``` +::: + + Orthography.asciiwhitespace + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem +``` +::: + Orthography.asciiCPs + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem +``` +::: + + Orthography.basicTypes + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem +``` +::: + Orthography.splitAsciiPunctuation + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem +``` +::: + Orthography.asciitokenforstring + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem +``` +::: + Orthography.isAsciiAlphabetic + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem +``` +::: + Orthography.isAsciiPunctuation + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem +``` +::: + Orthography.isAsciiNumeric + +:::{.callout-note appearance="minimal"} +```{julia} +#| echo: false +#| warning: false +@doc OrthographicSystem ``` +::: +