From 8b5b7dcc831a0ff1c660a0c0bca5d3cec376a5fc Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 31 Mar 2018 12:39:43 +0200 Subject: [PATCH] Add Link structure page to the documentation --- doc/md/Link-structure.md | 18 ++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 19 insertions(+) create mode 100644 doc/md/Link-structure.md diff --git a/doc/md/Link-structure.md b/doc/md/Link-structure.md new file mode 100644 index 0000000..0a2d0f8 --- /dev/null +++ b/doc/md/Link-structure.md @@ -0,0 +1,18 @@ +## Link structure + +Every link available through the `LinkDB` object is represented as an array +containing the following fields: + + * `id` (integer): Unique identifier. + * `title` (string): Title of the link. + * `url` (string): URL of the link. Used for displayable links (without redirector, url encoding, etc.). + Can be absolute or relative for Notes. + * `real_url` (string): Real destination URL, can be redirected, encoded, etc. + * `shorturl` (string): Permalink small hash. + * `description` (string): Link text description. + * `private` (boolean): whether the link is private or not. + * `tags` (string): all link tags separated by a single space + * `thumbnail` (string|boolean): relative path of the thumbnail cache file, or false if there isn't any. + * `created` (DateTime): link creation date time. + * `updated` (DateTime): last modification date time. + \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a1226e8..d03bc14 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,6 +35,7 @@ pages: - Continuous integration tools: Continuous-integration-tools.md - GnuPG signature: GnuPG-signature.md - Directory structure: Directory-structure.md + - Link Structure: Link-structure.md - 3rd party libraries: 3rd-party-libraries.md - Plugin System: Plugin-System.md - Release Shaarli: Release-Shaarli.md