The cl-acronyms Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-acronyms Reference Manual

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.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-acronyms

An acronym expander that utilizes a templating system.

How-to

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).

Dependencies

mobyposi.i

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.

Future

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: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-acronyms

Maintainer

Isoraķatheð Zorethan <isoraqathedh.zorethan@gmail.com>

Author

Isoraķatheð Zorethan <isoraqathedh.zorethan@gmail.com>

License

MIT

Description

A program that expands an acronym based on grammatical rules.

Version

1.0.0

Dependencies
Source

cl-acronyms.asd (file)

Component

cl-acronyms.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-acronyms.asd

Location

cl-acronyms.asd

Systems

cl-acronyms (system)

Packages

info.isoraqathedh.cl-acronyms.asdf


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-acronyms/cl-acronyms.lisp

Parent

cl-acronyms (system)

Location

cl-acronyms.lisp

Packages

info.isoraqathedh.cl-acronyms

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 info.isoraqathedh.cl-acronyms.asdf

Source

cl-acronyms.asd

Use List

Previous: , Up: Packages   [Contents][Index]

4.2 info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Nickname

cl-acronyms

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *master-structures-list*

The vector that holds all structures.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Special Variable: *master-word-list*

The word list holding all words and their parts of speech.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Special Variable: *word-list-file-location*

Location of which the list of words with part of speech modifiers are located.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: expand ACRONYM &optional TIMES

Expands an acronym. If ’times’ is provided, repeats expansion that many times and collects results into a list.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: refresh-list ()

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.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: refresh-structures ()

Resets the structure list to the value seen at the structures.lisp file.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: reset-list ()

Delete all entries from *master-word-list*. Returns t on success.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: total-entries ()

Returns the total length the dictionary.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: total-structures ()

Returns the total number of structures.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *report-stream*

Certain functions will print a progress bar in reading files. This is where it is printed to.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Special Variable: *structures-file-location*

Location of which the list of structures is located.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Special Variable: *word-count-array*

An array counting the number of words satisfying a given first letter and a given part of speech.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: %expand ACRONYM

Main acronym expansion logic.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: %read-structures ()

Reads the structures from structures.lisp.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: %reset-list ()

Blank list for *master-word-list*

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: decode-pos-letter LETTER

Turns the codes used by mobiposi.i into keywords corresponding to keys in the hash table.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: generate-word START-LETTER

Generates a (nonsensical) word that starts with the given letter.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: get-dictionary-length POS-LETTER START-LETTER

Returns how many words there are in the word.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: get-pos-template ACRONYM

Returns an appropriate part-of-speech template for a given acronym, ready for use in build-backronym.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: letter-associate-number LETTER

Turns A = 0, B = 1, ..., Z = 25

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: letterp THING
Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: pos-associate-number LETTER

Turns the codes used by mobiposi.i into keywords corresponding to keys in the hash table.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)

Function: random-word PART-OF-SPEECH &optional LETTER

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.

Package

info.isoraqathedh.cl-acronyms

Source

cl-acronyms.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-acronyms.asd: The cl-acronyms<dot>asd file
cl-acronyms/cl-acronyms.lisp: The cl-acronyms/cl-acronyms<dot>lisp file

F
File, Lisp, cl-acronyms.asd: The cl-acronyms<dot>asd file
File, Lisp, cl-acronyms/cl-acronyms.lisp: The cl-acronyms/cl-acronyms<dot>lisp file

L
Lisp File, cl-acronyms.asd: The cl-acronyms<dot>asd file
Lisp File, cl-acronyms/cl-acronyms.lisp: The cl-acronyms/cl-acronyms<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %  
D   E   F   G   L   P   R   T  
Index Entry  Section

%
%expand: Internal functions
%read-structures: Internal functions
%reset-list: Internal functions

D
decode-pos-letter: Internal functions

E
expand: Exported functions

F
Function, %expand: Internal functions
Function, %read-structures: Internal functions
Function, %reset-list: Internal functions
Function, decode-pos-letter: Internal functions
Function, expand: Exported functions
Function, generate-word: Internal functions
Function, get-dictionary-length: Internal functions
Function, get-pos-template: Internal functions
Function, letter-associate-number: Internal functions
Function, letterp: Internal functions
Function, pos-associate-number: Internal functions
Function, random-word: Internal functions
Function, refresh-list: Exported functions
Function, refresh-structures: Exported functions
Function, reset-list: Exported functions
Function, total-entries: Exported functions
Function, total-structures: Exported functions

G
generate-word: Internal functions
get-dictionary-length: Internal functions
get-pos-template: Internal functions

L
letter-associate-number: Internal functions
letterp: Internal functions

P
pos-associate-number: Internal functions

R
random-word: Internal functions
refresh-list: Exported functions
refresh-structures: Exported functions
reset-list: Exported functions

T
total-entries: Exported functions
total-structures: Exported functions

Jump to:   %  
D   E   F   G   L   P   R   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*master-structures-list*: Exported special variables
*master-word-list*: Exported special variables
*report-stream*: Internal special variables
*structures-file-location*: Internal special variables
*word-count-array*: Internal special variables
*word-list-file-location*: Exported special variables

S
Special Variable, *master-structures-list*: Exported special variables
Special Variable, *master-word-list*: Exported special variables
Special Variable, *report-stream*: Internal special variables
Special Variable, *structures-file-location*: Internal special variables
Special Variable, *word-count-array*: Internal special variables
Special Variable, *word-list-file-location*: Exported special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   I   P   S  
Index Entry  Section

C
cl-acronyms: The cl-acronyms system

I
info.isoraqathedh.cl-acronyms: The info<dot>isoraqathedh<dot>cl-acronyms package
info.isoraqathedh.cl-acronyms.asdf: The info<dot>isoraqathedh<dot>cl-acronyms<dot>asdf package

P
Package, info.isoraqathedh.cl-acronyms: The info<dot>isoraqathedh<dot>cl-acronyms package
Package, info.isoraqathedh.cl-acronyms.asdf: The info<dot>isoraqathedh<dot>cl-acronyms<dot>asdf package

S
System, cl-acronyms: The cl-acronyms system

Jump to:   C   I   P   S