aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2018-03-31 12:39:43 +0200
committerArthurHoaro <arthur@hoa.ro>2018-07-05 20:31:35 +0200
commit8b5b7dcc831a0ff1c660a0c0bca5d3cec376a5fc (patch)
tree3f8a6ddf0edf80e77cb3e7806f50409debca4e12 /doc/md
parente85b7a05a177f803ae36ba5c12835313f31177bc (diff)
downloadShaarli-8b5b7dcc831a0ff1c660a0c0bca5d3cec376a5fc.tar.gz
Shaarli-8b5b7dcc831a0ff1c660a0c0bca5d3cec376a5fc.tar.zst
Shaarli-8b5b7dcc831a0ff1c660a0c0bca5d3cec376a5fc.zip
Add Link structure page to the documentation
Diffstat (limited to 'doc/md')
-rw-r--r--doc/md/Link-structure.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/md/Link-structure.md b/doc/md/Link-structure.md
new file mode 100644
index 00000000..0a2d0f88
--- /dev/null
+++ b/doc/md/Link-structure.md
@@ -0,0 +1,18 @@
1## Link structure
2
3Every link available through the `LinkDB` object is represented as an array
4containing the following fields:
5
6 * `id` (integer): Unique identifier.
7 * `title` (string): Title of the link.
8 * `url` (string): URL of the link. Used for displayable links (without redirector, url encoding, etc.).
9 Can be absolute or relative for Notes.
10 * `real_url` (string): Real destination URL, can be redirected, encoded, etc.
11 * `shorturl` (string): Permalink small hash.
12 * `description` (string): Link text description.
13 * `private` (boolean): whether the link is private or not.
14 * `tags` (string): all link tags separated by a single space
15 * `thumbnail` (string|boolean): relative path of the thumbnail cache file, or false if there isn't any.
16 * `created` (DateTime): link creation date time.
17 * `updated` (DateTime): last modification date time.
18 \ No newline at end of file