From f961ce0f98c655364c6b780bc4dbf8f635e32cbc Mon Sep 17 00:00:00 2001 From: Henry Jameson Date: Sun, 15 Sep 2019 16:40:31 +0300 Subject: [PATCH] docs update --- docs/USER_GUIDE.md | 7 +++++++ docs/example_emoji.png | Bin 0 -> 491 bytes 2 files changed, 7 insertions(+) create mode 100644 docs/example_emoji.png diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index cb95a2440b..81490f2217 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -23,6 +23,13 @@ Posts will contain the text you are posting, but some content will be modified: **Depending on your instance some of the options might not be available or have different defaults** Let's clear up some basic stuff. When you post something it's called a **post** or it could be called a **status** or even a **toot** or a **prööt** depending on whom you ask. Post has body/content but it also has some other stuff in it - from attachments, visibility scope, subject line. +* **Emoji** are small images embedded in text, there are two major types of emoji: [unicode emoji](https://en.wikipedia.org/wiki/Emoji) and custom emoji. While unicode emoji are universal and standardized, they can appear differently depending on where you are using them or may not appear at all on older systems. Custom emoji are more *fun* kind - instance administrator can define many images as *custom emoji* for their users. This works very simple - custom emoji is defined by its *shortcode* and an image, so that any shortcode enclosed in colons get replaced with image if such shortcode exist. +Let's say there's `:pleroma:` emoji defined on instance. That means +> First time using :pleroma: pleroma! +will become +> First time using ![pleroma](./example_emoji.png) pleroma! +Note that you can only use emoji defined on your instance, you cannot "copy" someone else's emoji, and will have to ask your administrator to copy emoji from other instance to yours. +Lastly, there's two convenience options for emoji: an emoji picker (smiley face to the right of "submit" button) and autocomplete suggestions - when you start typing :shortcode: it will automatically try to suggest you emoj and complete the shortcode for you if you select one. **Note** that if emoji doesn't show up in suggestions nor in emoji picker it means there's no such emoji on your instance, if shortcode doesn't match any defined emoji it will appear as text. * **Attachments** are fairly simple - you can attach any file to a post as long as the file is within maximum size limits. If you're uploading explicit material you can mark all of your attachments as sensitive (or add `#nsfw` tag) - it will hide the images and videos behind a warning so that it won't be displayed instantly. * **Subject line** also known as **CW** (Content Warning) could be used as a header to the post and/or to warn others about contents of the post having something that might upset somebody or something among those lines. Several applications allow to hide post content leaving only subject line visible. As a side-effect using subject line will also mark your images as sensitive (see above). * **Visiblity scope** controls who will be able to see your posts. There are four scopes available: diff --git a/docs/example_emoji.png b/docs/example_emoji.png new file mode 100644 index 0000000000000000000000000000000000000000..0a22a256b00f1fbe962cd1988ec4df5cb6024bec GIT binary patch literal 491 zcmV<{Zw<2*9B?w#`Yw4B)3cGKFN_ ze2T3Iy{UCUO0kRr3CXsMBy0iLO2K4*>B__w z!1YU3Ex>19ss$*eDgY$|2zsj30ys5=Ct#%WEbcuNw-x`T>FwJ}5mo?7{~q{Dv%^6K zn(Hic;fo|&$FJo9=xVHCu)W@TgFa`~rodGt)B