NAME
spel-wizard.pl - converts spelchunks to to plain text
VERSION
version 20240610
SYNOPSIS
spel-wizard.pl [--help | -h] [--man|-m] [--test|-t] <jobname>
DESCRIPTION
The spel-wizard.pl script reads a SpeL index (.spelidx) file together with the .aux file (both generated by LaTeX) and converts the text of your LaTeX document (the text chunks) to audio files using a text-to-speech tool such as festival or awspolly. As a side effect it also produces MD5 fingerprints of these texts and an M3U audio file you can use as the start of an audio-book.
The spel-wizard.pl script is part of the SpeLbox package that contains multiple items:
- - a LaTeX package called spel.sty (Speech-enabled LaTeX)
- - an Orgmode exporter called spel
- - this script together with all modules from the SpeL::Wizard perl package
SpeLbox stands for Speech-enabled LaTeX by Orgmode eXport.
Starting by reading the documentation of the LaTeX package makes sense. We recommend reading this documentation after that. Finish with the Orgmode documentation if you still feel like it.
The .spelidx file
The index file is line-based. Every line consists of multiple fields separated by a pipe (|) symbol. Two types of lines exist: reading lines, containing information about what needs to be read out loud, and service lines that contain service information.
Reading lines
The first field indicates the element type (title, author, date, part, chapter, (sub)(sub)section, item, chunk). These lines are items that require text-to-speech conversion. The second field of these lines specifies the basename of the (.tex) file that contains the text to be read
Service lines
The service lines are described below:
- format: format of the audio that needs to be generated (ogg, wav or mp3)
- audiodir: specifies the directory in which the audio is to be generated
- chunkdir: specifies the directory in which the .tex-files (that need to be converted tot speech) are located
- language: specifies in wich language the subsequent
- macpp: specifies information about how a macro should be preprocessed
- envpp: specifies information about how an environment should be preprocessed
- macad: specifies an audiodescription for a macro
- envad: specifies an audiodescription for an environment
The configuration file
NAME
spel-wizard.pl - Incantating LaTeX into natural language
OPTIONS
- --help | -h
-
prints help message on standard output
- --man | -m
-
prints manual page on standard output
- --test | -t
-
write the results to standard output; this facility is provided for development, debugging and testing purposes.
- --verbose | -v
-
increase the verbosity of the script. Usually a single
-vis a sensible amount of verbosity.
ARGUMENT
- <jobname>
-
basename of your latex input file; this will allow
spel-wizard.plto find the .aux file and the .spelidx file.
RETURN VALUE
- 0 if no errors occurred
- 1 if a command-line syntax error occurred
- 100 if the help message was invoked (e.g., using '-h')
- 101 if the man page was invoked (e.g., using '-m')
- 102 if the script was run in test mode (using '-t')
- 13 insufficient read permissions for the config file
- 14 parsing the config file failed
BUGS
No bugs have been reported so far. If you find any, please, send an e-mail to the author containing:
- - what you were trying;
- - enough data such that I can reproduce your attempt (.spelidx file, .aux file and the contents of your spel directory)
- - what strange behavior you observed;
- - what normal behavior you would have expected.
LINKS
AUTHOR
Walter Daems <wdaems@cpan.org>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2024 by Walter Daems.
This is free software, licensed under:
The GNU General Public License, Version 3, June 2007CONTRIBUTOR
Paul Levrie