This is the cl-slug Reference Manual, version 0.4.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:23:46 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-slugSmall library to make slugs, mainly for URIs, from english and beyond.
André Miranda
André Miranda
(GIT git@github.com:EuAndreh/cl-slug.git)
LLGPL
# cl-slug
[](http://quickdocs.org/cl-slug/)
[](https://travis-ci.org/EuAndreh/cl-slug)
[](https://circleci.com/gh/EuAndreh/cl-slug)
[](https://coveralls.io/r/EuAndreh/cl-slug?branch=master)
Easily create slugs from any string. Supports many languages alphabets. See [Supported languages](#supported-languages) to check for supported languages or to help to add one.
Inspired by [Lisp Web Tales](http://lispwebtales.ppenev.com/chap05.html#leanpub-auto-rewriting-the-routes).
## Usage
“‘lisp
* (ql:quickload :cl-slug)
; => (:CL-SLUG)
* (import ’(slug:slugify slug:asciify slug:CamelCaseFy))
; => T
“‘
The main function is called ‘slugify‘:
“‘lisp
* (slugify "My new cool article, for the blog (V. 2).")
; => "my-new-cool-article-for-the-blog-v-2"
* (slugify "André Miranda")
; => "andre-miranda"
“‘
‘slugify‘ removes any accented character, replacing it with an unaccented equivalent, and any punctuation (a punctuation is a char that returns ‘NIL‘ for ‘alphanumericp‘) and puts a dash (‘-‘) on it’s place. You can change that by binding (of ‘setf‘ing) ‘*slug-separator*‘:
“‘lisp
* (let ((*slug-separator* #\_))
(slugify "Testing the *slug-separator* var..."))
; => "testing_the_slug_separator_var"
“‘
‘slugify‘ also ignores numbers:
“‘lisp
* (slugify "one2three4five")
; => "one2three4five"
“‘
If you just want to remove accents and punctuation of a given string, use ‘asciify‘:
“‘lisp
* (asciify "Eu André!")
; => "Eu Andre!"
“‘
Or if you want a CamelCase, use ‘CamelCaseFy‘:
“‘lisp
* (CamelCaseFy "My new camel case string")
; => "MyNewCamelCaseString"
“‘
Available languages are stored in ‘*available-languages*‘:
“‘lisp
* slug:*available-languages*
((:TR . "Türkçe (Turkish)") (:SV . "Svenska (Swedish)") (:FI . "Suomi (Finnish)")
(:UK . "українська (Ukrainian)") (:RU . "Ру́сский (Russian)") (:RO . "Română (Romanian)")
(:RM . "Rumàntsch (Romansh)") (:PT . "Português (Portuguese)") (:PL . "Polski (Polish)")
(:NO . "Norsk (Norwegian)") (:LT . "Lietuvių (Lithuanian)") (:LV . "Latviešu (Latvian)")
(:LA . "Lingua Latīna (Latin)") (:IT . "Italiano (Italian)") (:EL . "ελληνικά (Greek)")
(:FR . "Français (French)") (:EO . "Esperanto") (:ES . "Español (Spanish)") (:EN . "English")
(:DE . "Deutsch (German)") (:DA . "Dansk (Danish)") (:CS . "Čeština (Czech)")
(:CURRENCY . "Currency"))
“‘
## Dependencies
This library depends on [CL-PPCRE](http://weitz.de/cl-ppcre). The test package uses the [prove](https://github.com/fukamachi/prove) test library.
## Installation
Available on [Quicklisp](http://quicklisp.org):
“‘
(ql:quickload :cl-slug)
“‘
## Supported languages
The languages that are supported right now are:
- english
- portuguese
- esperanto
- german
- french
- swedish
- finnish
- norwegian
- danish
- italian
- spanish
- romansh
Ported from [Django](https://code.djangoproject.com/browser/django/trunk/django/contrib/admin/media/js/urlify.js)():
- currency
- romanian
- lithuanian
- latvian
- polish
- czesh
- ukranian
- russian
- turkish
- greek
- latin
At the present moment, adding new languages is a fairly manual process:
1. Identify non-ASCII characters in a given language’s alphabet
2. Establish equivalence between the found characters and ASCII characters
3. Write them down in the code.
All those things can actually be done for most of the dominant Western languages, but can’t be applied for minor regional languages or many other non-Latin languages from the whole world, like Chinese. It’s not generic and not scalable.
I couldn’t think of a solution so far for this, but if you know a solution (even a partial one) I’d be glad to hear =].
## Bugs
If you find any bug or inconsistency in the code, or if you find it too hard to use, please, feel free to open an issue.
## Tests
This library is tested under [ABCL](https://common-lisp.net/project/armedbear/), [SBCL](http://www.sbcl.org/), [CCL](http://ccl.clozure.com/), [CLISP](http://www.clisp.org/) and [ECL](https://common-lisp.net/project/ecl/) Common Lisp implementations.
To run all the defined tests, use:
“‘lisp
* (asdf:test-system :cl-slug)
; prints lots of (colorful) stuff...
; => T
“‘
Tests are ran with [Travis CI](https://travis-ci.org/EuAndreh/cl-slug) and [Circle CI](https://circleci.com/gh/EuAndreh/cl-slug) using [cl-travis](https://github.com/luismbo/cl-travis), [CIM](https://github.com/KeenS/CIM), [cl-coveralls](https://github.com/fukamachi/cl-coveralls) and [Roswell](https://github.com/snmsts/roswell). Check it out!
## Author
André Miranda.
## License
[LLGPL](https://tldrlegal.com/license/lisp-lesser-general-public-license#fulltext).
0.4.1
cl-ppcre (system).
Modules are listed depth-first from the system components tree.
Files are sorted by type and then listed depth-first from the systems components trees.
cl-slug/src/cl-slug.lispsrc (module).
*available-languages* (special variable).
*slug-separator* (special variable).
asciify (function).
camelcasefy (function).
slugify (function).
%accentuations (special variable).
%special-chars (special variable).
add-language (macro).
last-char (function).
remove-accentuation (function).
remove-ponctuation (function).
remove-special-chars (function).
Packages are listed by definition order.
cl-slugMain (and only) package. Package nickname SLUG also available.
slug
common-lisp.
*available-languages* (special variable).
*slug-separator* (special variable).
asciify (function).
camelcasefy (function).
slugify (function).
%accentuations (special variable).
%special-chars (special variable).
add-language (macro).
last-char (function).
remove-accentuation (function).
remove-ponctuation (function).
remove-special-chars (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Alist with (KEY . LANGUAGE-NAMESTRING).
Default separator of slug strings.
Removes the accentuation and ponctuation of the given STRING.
Makes STRING CamelCase, also removing ponctuation and accentuation.
Makes STRING a slug: a downcase string, with no special characters, ponctuation or accentuated letters whatsoever.
Hash table of all {accentuation -> ascii-equivalent} characters.
Hash table of all {special-char -> ascii-equivalent} strings.
Returns the last char of a non-empty string.
Removes accentuation (according to %ACCENTUATIONS) from STRING.
Removes ponctuation and other special characters from STRING according #’ALPHANUMERICP.
Removes all special characters stored in %SPECIAL-CHARS using #’PPCRE:REPLACE-REGEX-ALL.
| Jump to: | A C F L M R S |
|---|
| Jump to: | A C F L M R S |
|---|
| Jump to: | %
*
S |
|---|
| Jump to: | %
*
S |
|---|
| Jump to: | C F M P R S |
|---|
| Jump to: | C F M P R S |
|---|