The cl-slug Reference Manual

This is the cl-slug Reference Manual, version 0.4.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:43:26 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-slug

Small library to make slugs, mainly for URIs, from english and beyond.

Maintainer

André Miranda

Author

André Miranda

Contact

Home Page

https://github.com/EuAndreh/cl-slug

Source Control

(GIT git@github.com:EuAndreh/cl-slug.git)

Bug Tracker

https://github.com/EuAndreh/cl-slug/issues

License

LLGPL

Long Description

# cl-slug
[![Quicklisp](http://quickdocs.org/badge/cl-slug.svg)](http://quickdocs.org/cl-slug/)
[![Build Status](https://travis-ci.org/EuAndreh/cl-slug.svg?branch=master)](https://travis-ci.org/EuAndreh/cl-slug)
[![Circle CI](https://circleci.com/gh/EuAndreh/cl-slug.svg?style=svg)](https://circleci.com/gh/EuAndreh/cl-slug)
[![Coverage Status](https://coveralls.io/repos/EuAndreh/cl-slug/badge.svg?branch=master)](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).

Version

0.4.1

Dependency

cl-ppcre (system).

Source

cl-slug.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-slug/src

Source

cl-slug.asd.

Parent Component

cl-slug (system).

Child Component

cl-slug.lisp (file).


4 Files

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


4.1 Lisp


4.1.1 cl-slug/cl-slug.asd

Source

cl-slug.asd.

Parent Component

cl-slug (system).

ASDF Systems

cl-slug.


4.1.2 cl-slug/src/cl-slug.lisp

Source

cl-slug.asd.

Parent Component

src (module).

Packages

cl-slug.

Public Interface
Internals

4.2 Static


4.2.1 cl-slug/README.md

Source

cl-slug.asd.

Parent Component

cl-slug (system).


5 Packages

Packages are listed by definition order.


5.1 cl-slug

Main (and only) package. Package nickname SLUG also available.

Source

cl-slug.lisp.

Nickname

slug

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *available-languages*

Alist with (KEY . LANGUAGE-NAMESTRING).

Package

cl-slug.

Source

cl-slug.lisp.

Special Variable: *slug-separator*

Default separator of slug strings.

Package

cl-slug.

Source

cl-slug.lisp.


6.1.2 Ordinary functions

Function: asciify (string)

Removes the accentuation and ponctuation of the given STRING.

Package

cl-slug.

Source

cl-slug.lisp.

Function: camelcasefy (string)

Makes STRING CamelCase, also removing ponctuation and accentuation.

Package

cl-slug.

Source

cl-slug.lisp.

Function: slugify (string)

Makes STRING a slug: a downcase string, with no special characters, ponctuation or accentuated letters whatsoever.

Package

cl-slug.

Source

cl-slug.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: %accentuations

Hash table of all {accentuation -> ascii-equivalent} characters.

Package

cl-slug.

Source

cl-slug.lisp.

Special Variable: %special-chars

Hash table of all {special-char -> ascii-equivalent} strings.

Package

cl-slug.

Source

cl-slug.lisp.


6.2.2 Macros

Macro: add-language (name key-code accentuation-alist &optional special-chars-alist)
Package

cl-slug.

Source

cl-slug.lisp.


6.2.3 Ordinary functions

Function: last-char (string)

Returns the last char of a non-empty string.

Package

cl-slug.

Source

cl-slug.lisp.

Function: remove-accentuation (string)

Removes accentuation (according to %ACCENTUATIONS) from STRING.

Package

cl-slug.

Source

cl-slug.lisp.

Function: remove-ponctuation (string)

Removes ponctuation and other special characters from STRING according #’ALPHANUMERICP.

Package

cl-slug.

Source

cl-slug.lisp.

Function: remove-special-chars (string)

Removes all special characters stored in %SPECIAL-CHARS using #’PPCRE:REPLACE-REGEX-ALL.

Package

cl-slug.

Source

cl-slug.lisp.


Appendix A Indexes


A.1 Concepts