Skip to main content

Package for disambiguation of identical terms in critical editions in LaTeX with reledmac.

Project description

Samewords
=========

[![Documentation
Status](https://readthedocs.org/projects/samewords/badge/?version=latest)](http://samewords.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/92066873.svg)](https://zenodo.org/badge/latestdoi/92066873)



*Word disambigutaion in critical text editions*

In critical textual editions notes in the critical apparatus are
normally made to the line where the words occur. This leads to ambiguous
references when a critical apparatus note refers to a word that occurs
more than once in a line. For example:

We have a passage of text here, such a nice place for a critical
note.

----
1 a] om. M

It is very unclear which of three instances of "a" the note refers to.

[Reledmac](https://www.ctan.org/pkg/reledmac) is a great LaTeX package
that facilitates typesetting critical editions of prime quality. It
already provides facilities for disambiguating identical words, but it
requires the creator of the critical text to mark all potential
instances of ambiguous references manually (see the *reledmac* handbook
for the details on that). *Samewords* automates this step for the
editor.

Install and usage
-----------------

``` {.sourceCode .bash}
pip3 install samewords
```

That's it!

This requires Python 3.6 installed in your system. For more details on
installation, see the [installation]{role="ref"} section.

Now call the script with the file you want annotated as the only
argument to get the annotated version back in the terminal.

``` {.sourceCode .bash}
samewords my-awesome-edition.tex
```

This will send the annotated version to `stdout`. To see that it
actually contains some `\sameword{}` macros, you can try running it
through `grep`:

``` {.sourceCode .bash}
samewords my-awesome-edition.tex | grep sameword
```

You can define a output location with the `--output` option:

``` {.sourceCode .bash}
samewords --output ~/Desktop/test/output my-awesome-edition.tex
```

This will check whether `~/Desktop/test/output` is a directory or a
file. If it is a directory, it will put the file inside that directory
(with the original name). If it is a file, it will ask you whether you
want to overwrite it. If it is neither a directory nor a file, it will
create the file `output` and write the content to that.

Alternatively regular unix redirecting will work just as well in a Unix
context:

``` {.sourceCode .bash}
samewords my-beautiful-edition.tex > ~/Desktop/test/output.tex
```

See more in the
[documentation](https://samewords.readthedocs.io/en/latest/).


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

samewords-0.5.1.tar.gz (42.9 kB view details)

Uploaded Source

Built Distribution

samewords-0.5.1-py3-none-any.whl (41.1 kB view details)

Uploaded Python 3

File details

Details for the file samewords-0.5.1.tar.gz.

File metadata

  • Download URL: samewords-0.5.1.tar.gz
  • Upload date:
  • Size: 42.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/18.2 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.5

File hashes

Hashes for samewords-0.5.1.tar.gz
Algorithm Hash digest
SHA256 458328a41fbd231bcb2e04b5a910942419d6b71c46d3d481bf076e99ecec73f5
MD5 bbfa9f71c31530b08934991ebc67d7e1
BLAKE2b-256 aa67de88c34ae256a7f7a0595d1185a4da802e76c7324811dbbe4cddd0cf1325

See more details on using hashes here.

File details

Details for the file samewords-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: samewords-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 41.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/18.2 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.5

File hashes

Hashes for samewords-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ec67fa6760e41a5da5d56a89e92abf621616d94ddd5f3ebcea1ad86315d1808c
MD5 11895846cee9eb692959efe1104f7c64
BLAKE2b-256 955daab797bb9a45732298f3ec5aa9bb8c9b00f5d4b2b6577df934123189b303

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page