Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-acronyms Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:56:23 2018 GMT+0.
| • Introduction: | What cl-acronyms is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
An acronym expander that utilizes a templating system.
After loading the system,
simply use (acronyms:expand your-acronym-here)
to generate an phrase
that has the first letter of each "main word" be your-acronym-here.
Optionally, providing a numerical argument
like (acronyms:expand your-acronym-here iteration)
will expand that acronym iteration times,
and collect all results into a list.
You can reload the list of words by evaluating (refresh-list).
This will load a file named "mobiposi.i"
in the same directory as the code into the program.
You can find out how many entries the dictionary has
through (total-entries) and (total-structures).
If for any reason you wish to delete the list without reloading a new one,
use (reset-list).
cl-acronyms uses mobyposi.i, a list of words with tags that indicates each word's part of speech. The version that this code uses the multiplication sign "×" as the delimeter between words and tags, uses Unix file endings, and was converted to use Unicode. There are some known problems with the data, particularly regarding letters with diacritics, that proves difficult to fix given the sheer size of the file.
When loading the list,
(refresh-list) will automatically skip any entries that have spaces in them,
as those are unsuitable targets for an expansion of the acronym.
The file contains some unusual, uncommon or obsolete words that may confuse a reader that might use it just for laughs. Interested parties can provide a less confusing list with a similar size.
cl-acronyms also depends on alexandria and split-sequence in the current setup.
cl-acronyms remains a work in progress, though it works out of the box as it is. Below are some of the things that are desired for future versions, in no particular order:
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The cl-acronyms system: |
Isoraķatheð Zorethan <isoraqathedh.zorethan@gmail.com>
Isoraķatheð Zorethan <isoraqathedh.zorethan@gmail.com>
MIT
A program that expands an acronym based on grammatical rules.
1.0.0
cl-acronyms.asd (file)
cl-acronyms.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The cl-acronyms.asd file: | ||
| • The cl-acronyms/cl-acronyms.lisp file: |
Next: The cl-acronyms/cl-acronyms<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-acronyms.asd
cl-acronyms (system)
Previous: The cl-acronyms<dot>asd file, Up: Lisp files [Contents][Index]
cl-acronyms (system)
cl-acronyms.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The info.isoraqathedh.cl-acronyms.asdf package: | ||
| • The info.isoraqathedh.cl-acronyms package: |
Next: The info<dot>isoraqathedh<dot>cl-acronyms package, Previous: Packages, Up: Packages [Contents][Index]
cl-acronyms.asd
Previous: The info<dot>isoraqathedh<dot>cl-acronyms<dot>asdf package, Up: Packages [Contents][Index]
cl-acronyms.lisp (file)
cl-acronyms
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported special variables: | ||
| • Exported functions: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
The vector that holds all structures.
cl-acronyms.lisp (file)
The word list holding all words and their parts of speech.
cl-acronyms.lisp (file)
Location of which the list of words with part of speech modifiers are located.
cl-acronyms.lisp (file)
Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Expands an acronym. If ’times’ is provided, repeats expansion that many times and collects results into a list.
cl-acronyms.lisp (file)
Reloads the list from mobiposi.i, replacing all entries orginally in *master-word-list*.
Returns the number of items placed into the word bank.
Skips any entries that have spaces.
cl-acronyms.lisp (file)
Resets the structure list to the value seen at the structures.lisp file.
cl-acronyms.lisp (file)
Delete all entries from *master-word-list*. Returns t on success.
cl-acronyms.lisp (file)
Returns the total length the dictionary.
cl-acronyms.lisp (file)
Returns the total number of structures.
cl-acronyms.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables: | ||
| • Internal functions: |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Certain functions will print a progress bar in reading files. This is where it is printed to.
cl-acronyms.lisp (file)
Location of which the list of structures is located.
cl-acronyms.lisp (file)
An array counting the number of words satisfying a given first letter and a given part of speech.
cl-acronyms.lisp (file)
Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Main acronym expansion logic.
cl-acronyms.lisp (file)
Reads the structures from structures.lisp.
cl-acronyms.lisp (file)
Blank list for *master-word-list*
cl-acronyms.lisp (file)
Turns the codes used by mobiposi.i into keywords corresponding to keys in the hash table.
cl-acronyms.lisp (file)
Generates a (nonsensical) word that starts with the given letter.
cl-acronyms.lisp (file)
Returns how many words there are in the word.
cl-acronyms.lisp (file)
Returns an appropriate part-of-speech template for a given acronym, ready for use in build-backronym.
cl-acronyms.lisp (file)
Turns A = 0, B = 1, ..., Z = 25
cl-acronyms.lisp (file)
cl-acronyms.lisp (file)
Turns the codes used by mobiposi.i into keywords corresponding to keys in the hash table.
cl-acronyms.lisp (file)
Grabs a random word starting with the given part of speech starting with letter, if given.
If part-of-speech is supplied as a word, then that word is used, discarding letter.
[This is so to facilitate build-acronym].
If a letter is supplied, will only supply words that start with that letter;
if no such word exists, then a nonce word is generated instead.
cl-acronyms.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | C F L |
|---|
| Jump to: | C F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | %
D E F G L P R T |
|---|
| Jump to: | %
D E F G L P R T |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C I P S |
|---|
| Jump to: | C I P S |
|---|