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

Expand testing and documentation #38

Merged
merged 1 commit into from
Mar 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "PolytonicGreek"
uuid = "72b824a7-2b4a-40fa-944c-ac4f345dc63a"
authors = ["Neel Smith <dnsmith.neel@gmail.com>"]
version = "0.6.1"
version = "0.6.2"

[deps]
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
Expand Down
31 changes: 31 additions & 0 deletions docs/src/guide/accents.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
```@meta
CurrentModule = PolytonicGreek
```

# Accentuation



Overview: two exported functions allows you to remove accents from a string, or add accent to a "word" (a single lexical token). Words may be accented either with recessive accent, or with persistent accent in the penult, indicated with a second parameter which should be either the symbol `:RECESSIVE` or `:PENULT`.

!!! note
Words cannot be accented on the ultima based on orthography alone; that requires further knowledge of the morphological form of the word.


```jldoctest accented
using PolytonicGreek
rmaccents("πολλά")

# output

"πολλα"
```

```jldoctest accented
accentword("ἀνθρωπος", :RECESSIVE)

# output

"ἄνθρωπος"
```


184 changes: 184 additions & 0 deletions docs/src/guide/syllabification.md
Original file line number Diff line number Diff line change
@@ -1 +1,185 @@
```@meta
CurrentModule = PolytonicGreek
```


# Syllabification

The `syllabify` functions handles the complex task of dividing Greek words into syllables, and returns an Array of string values. Accents are removed from the result since accents are only meaning as parts of a complete lexical token or phrase.

The following examples illustrate correct division of a variety of consonant and vowel patterns.

```jldoctest syllables
using PolytonicGreek
syllables = syllabify("ἄνδρασι")
join(syllables, "-")

# output

"ἀν-δρα-σι"
```
```jldoctest syllables
syllables = syllabify("προΐστημι")
join(syllables, "-")

# output

"προ-ϊ-στη-μι"
```
```jldoctest syllables
syllables = syllabify("ἀναμιμνησκόμενος")
join(syllables, "-")

# output

"ἀ-να-μι-μνη-σκο-με-νος"
```

```jldoctest syllables
syllables = syllabify("καταβάλλω")
join(syllables, "-")

# output

"κα-τα-βαλ-λω"
```


```jldoctest syllables
syllables = syllabify("δέομαι")
join(syllables, "-")

# output

"δε-ο-μαι"
```



```jldoctest syllables
syllables = syllabify("ὀΐω")
join(syllables, "-")

# output

"ὀ-ϊ-ω"
```



```jldoctest syllables
syllables = syllabify("ὀίω")
join(syllables, "-")

# output

"ὀι-ω"
```


```jldoctest syllables
syllables = syllabify("ἑωρακυῖα")
join(syllables, "-")

# output

"ἑ-ω-ρα-κυι-α"
```




```jldoctest syllables
syllables = syllabify("δεδιέναι")
join(syllables, "-")

# output

"δε-δι-ε-ναι"
```



```jldoctest syllables
syllables = syllabify("ἔργμα")
join(syllables, "-")

# output

"ἐρ-γμα"
```



```jldoctest syllables
syllables = syllabify("οὐδέποτε")
join(syllables, "-")

# output

"οὐ-δε-πο-τε"
```



```jldoctest syllables
syllables = syllabify("κελεύει")
join(syllables, "-")

# output

"κε-λευ-ει"
```


```jldoctest syllables
syllables = syllabify("οἰκίαις")
join(syllables, "-")

# output

"οἰ-κι-αις"
```



```jldoctest syllables
syllables = syllabify("θύειν")
join(syllables, "-")

# output

"θυ-ειν"
```


```jldoctest syllables
syllables = syllabify("ποιησαίμην")
join(syllables, "-")

# output

"ποι-η-σαι-μην"
```



```jldoctest syllables
syllables = syllabify("ποῖος")
join(syllables, "-")

# output

"ποι-ος"
```


```jldoctest syllables
syllables = syllabify("γνώμην")
join(syllables, "-")

# output

"γνω-μην"
```