Commit b6af38af authored by Gábor Melis's avatar Gábor Melis
Browse files

unbreak links on github

parent 3f87baf6
Loading
Loading
Loading
Loading
+5 −27
Changes for README.md: 5 added lines, 27 removed lines.
Original line number Diff line number Diff line
<a id="x-28TRIVIAL-UTF-8-3A-40TRIVIAL-UTF-8-MANUAL-20MGL-PAX-3ASECTION-29"></a>
<a id="TRIVIAL-UTF-8:@TRIVIAL-UTF-8-MANUAL%20MGL-PAX:SECTION"></a>

# Trivial UTF-8 Manual

## Table of Contents
@@ -12,8 +10,6 @@

###### \[in package TRIVIAL-UTF-8\]
<a id="x-28-22trivial-utf-8-22-20ASDF-2FSYSTEM-3ASYSTEM-29"></a>
<a id="%22trivial-utf-8%22%20ASDF%2FSYSTEM:SYSTEM"></a>

## 1 TRIVIAL-UTF-8 ASDF System Details

- Description: A small library for doing UTF-8-based input and output.
@@ -25,8 +21,6 @@
- Source control: [GIT](https://gitlab.common-lisp.net/trivial-utf-8/trivial-utf-8.git)

<a id="x-28TRIVIAL-UTF-8-3A-40TRIVIAL-UTF-8-INTRODUCTION-20MGL-PAX-3ASECTION-29"></a>
<a id="TRIVIAL-UTF-8:@TRIVIAL-UTF-8-INTRODUCTION%20MGL-PAX:SECTION"></a>

## 2 Introduction

Trivial UTF-8 is a small library for doing UTF-8-based in- and
@@ -48,8 +42,6 @@ on any other libraries.


<a id="x-28TRIVIAL-UTF-8-3A-40TRIVIAL-UTF-8-LINKS-20MGL-PAX-3ASECTION-29"></a>
<a id="TRIVIAL-UTF-8:@TRIVIAL-UTF-8-LINKS%20MGL-PAX:SECTION"></a>

## 3 Links

Here is the [official repository][trivial-utf-8-repo] and the
@@ -61,36 +53,26 @@ Here is the [official repository][trivial-utf-8-repo] and the


<a id="x-28TRIVIAL-UTF-8-3A-40TRIVIAL-UTF-8-REFERENCE-20MGL-PAX-3ASECTION-29"></a>
<a id="TRIVIAL-UTF-8:@TRIVIAL-UTF-8-REFERENCE%20MGL-PAX:SECTION"></a>

## 4 Reference

<a id="x-28TRIVIAL-UTF-8-3AUTF-8-BYTE-LENGTH-20FUNCTION-29"></a>
<a id="TRIVIAL-UTF-8:UTF-8-BYTE-LENGTH%20FUNCTION"></a>

- [function] **UTF-8-BYTE-LENGTH** *STRING*

    Calculate the amount of bytes needed to encode `STRING`.

<a id="x-28TRIVIAL-UTF-8-3ASTRING-TO-UTF-8-BYTES-20FUNCTION-29"></a>
<a id="TRIVIAL-UTF-8:STRING-TO-UTF-8-BYTES%20FUNCTION"></a>

- [function] **STRING-TO-UTF-8-BYTES** *STRING &KEY NULL-TERMINATE*

    Convert `STRING` into an array of unsigned bytes containing its UTF-8
    representation. If `NULL-TERMINATE`, add an extra 0 byte at the end.

<a id="x-28TRIVIAL-UTF-8-3AUTF-8-GROUP-SIZE-20FUNCTION-29"></a>
<a id="TRIVIAL-UTF-8:UTF-8-GROUP-SIZE%20FUNCTION"></a>

- [function] **UTF-8-GROUP-SIZE** *BYTE*

    Determine the amount of bytes that are part of the character whose
    encoding starts with `BYTE`. May signal [`UTF-8-DECODING-ERROR`][ad1e].

<a id="x-28TRIVIAL-UTF-8-3AUTF-8-BYTES-TO-STRING-20FUNCTION-29"></a>
<a id="TRIVIAL-UTF-8:UTF-8-BYTES-TO-STRING%20FUNCTION"></a>

- [function] **UTF-8-BYTES-TO-STRING** *BYTES &KEY (START 0) (END (LENGTH BYTES))*

    Convert the `START`, `END` subsequence of the array of `BYTES` containing
@@ -99,8 +81,6 @@ Here is the [official repository][trivial-utf-8-repo] and the
    an `(UNSIGNED-BYTES 8)` array. May signal [`UTF-8-DECODING-ERROR`][ad1e].

<a id="x-28TRIVIAL-UTF-8-3AREAD-UTF-8-STRING-20FUNCTION-29"></a>
<a id="TRIVIAL-UTF-8:READ-UTF-8-STRING%20FUNCTION"></a>

- [function] **READ-UTF-8-STRING** *INPUT &KEY NULL-TERMINATED STOP-AT-EOF (CHAR-LENGTH -1) (BYTE-LENGTH -1)*

    Read UTF-8 encoded data from `INPUT`, a byte stream, and construct a
@@ -112,20 +92,18 @@ Here is the [official repository][trivial-utf-8-repo] and the
    [`UTF-8-DECODING-ERROR`][ad1e].

<a id="x-28TRIVIAL-UTF-8-3AUTF-8-DECODING-ERROR-20CONDITION-29"></a>
<a id="TRIVIAL-UTF-8:UTF-8-DECODING-ERROR%20CONDITION"></a>

- [condition] **UTF-8-DECODING-ERROR** *SIMPLE-ERROR*

  [3c3e]: #TRIVIAL-UTF-8:@TRIVIAL-UTF-8-LINKS%20MGL-PAX:SECTION "Links"
  [3c3e]: #x-28TRIVIAL-UTF-8-3A-40TRIVIAL-UTF-8-LINKS-20MGL-PAX-3ASECTION-29 "Links"
  [4267]: http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm "STRING TYPE"
  [7959]: http://www.lispworks.com/documentation/HyperSpec/Body/f_coerce.htm "COERCE FUNCTION"
  [7e2c]: http://www.lispworks.com/documentation/HyperSpec/Body/f_char_c.htm "CHAR-CODE FUNCTION"
  [a043]: #TRIVIAL-UTF-8:@TRIVIAL-UTF-8-REFERENCE%20MGL-PAX:SECTION "Reference"
  [ad1e]: #TRIVIAL-UTF-8:UTF-8-DECODING-ERROR%20CONDITION "TRIVIAL-UTF-8:UTF-8-DECODING-ERROR CONDITION"
  [a043]: #x-28TRIVIAL-UTF-8-3A-40TRIVIAL-UTF-8-REFERENCE-20MGL-PAX-3ASECTION-29 "Reference"
  [ad1e]: #x-28TRIVIAL-UTF-8-3AUTF-8-DECODING-ERROR-20CONDITION-29 "TRIVIAL-UTF-8:UTF-8-DECODING-ERROR CONDITION"
  [cc17]: http://www.lispworks.com/documentation/HyperSpec/Body/e_end_of.htm "END-OF-FILE CONDITION"
  [d796]: http://www.lispworks.com/documentation/HyperSpec/Body/f_code_c.htm "CODE-CHAR FUNCTION"
  [d9f2]: #%22trivial-utf-8%22%20ASDF%2FSYSTEM:SYSTEM '"trivial-utf-8" ASDF/SYSTEM:SYSTEM'
  [e14a]: #TRIVIAL-UTF-8:@TRIVIAL-UTF-8-INTRODUCTION%20MGL-PAX:SECTION "Introduction"
  [d9f2]: #x-28-22trivial-utf-8-22-20ASDF-2FSYSTEM-3ASYSTEM-29 '"trivial-utf-8" ASDF/SYSTEM:SYSTEM'
  [e14a]: #x-28TRIVIAL-UTF-8-3A-40TRIVIAL-UTF-8-INTRODUCTION-20MGL-PAX-3ASECTION-29 "Introduction"

* * *
###### \[generated by [MGL-PAX](https://github.com/melisgl/mgl-pax)\]
+2 −2
Changes for doc.lisp: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -55,6 +55,6 @@

#+nil
(progn
  (update-asdf-system-readmes @trivial-utf-8-manual :trivial-utf-8)
  (update-asdf-system-html-docs @trivial-utf-8-manual :trivial-utf-8
  (pax:update-asdf-system-readmes @trivial-utf-8-manual :trivial-utf-8)
  (pax:update-asdf-system-html-docs @trivial-utf-8-manual :trivial-utf-8
                                    :pages (pax-pages)))