tkr - Usage

tkr is a personal feed. It's designed for short, text-only status updates. It provides RSS and atom feeds. It also provides some personalization features, like moods and CSS uploads. I've tried to make it self-explanatory, but this page explains how to use the different features.

Posts

From the main page, you can enter posts that get added to the feed. You can delete posts for a short period of time (configurable in the settings). You can also set your mood with an emoji.

When you first load tkr, it will look something like this.

Click the "login" link at the top to log in. When logged in, the page looks like this.

To make a post, enter some text into the "What's ticking?" box and click "Tick." Posts are text-only, but you can add emojis and hyperlinks will render in the feed as clickable links. For example:

See the trash can next to "0 minutes ago" above the post? You can click that to delete the post if you made a mistake or changed your mind about posting. You have an hour to delete posts by default. This can be configured in the settings.

tkr provides rss and atom feeds at /rss and /atom respectively. The links are advertised in the page metadata, so feed readers will be able to find them from the main page (or any tkr page).

Moods

You can assign a mood by clicking the "Change mood" link next to your display name on the left. When you click it, you'll be taken to the world's most overengineered emoji selection screen. I wanted to see if I could build a pure-html screen and this is what happened.

Click on an emoji, then scroll to the bottom and click the "Set the mood" button.

You'll be returned to the homepage, and your new mood will display next to your username.

Adding moods

tkr provides a default set of emojis, but not all. If you'd like to use other emojis for moods, you can add them from the emoji admin page.

Paste an emoji into the "Enter an emoji" field and add a description in the description field. Then click "Add emoji" to add it to your list of emojis.

If you want to delete an emoji later, you can select the checkbox next to it in the "Delete Emoji" section and click "Delete selected emoji."

Emoji that you add will show up at the top of the mood selection screen, in the "Custom" section.

Custom CSS

You can upload a custom CSS files from the CSS Management screen (admin -> css).

Click the "Choose File" in the Upload section, browse to your CSS file, and Click "Upload CSS file" to save it.

Once uploaded, you can select a CSS file from the "Manage" section to change the theme. The forest-green.css file ins example turns some of the UI elements green.

You can delete an uploaded theme by clicking the "Delete" button in the "Manage" section. If the theme you delete is currently active, tkr will revert to the default theme. The default theme can't be deleted.

Logs

You can view system logs by going to the Logs viewer (admin->logs).

You can change the log level by going to the Settings page (admin->settings) and changing the Log Level value. This dropdown sets the lowest level of event that is written to the logs. So, if you select "WARNING", then only WARNING and ERROR messages will be written. If you select "DEBUG", then all events (DEBUG, INFO, WARNING, and ERROR) will be written.

The DEBUG logs are pretty verbose, but can be helpful for diagnosing errors or can just be fun if you're curous about what's going on. Here's a sample.

You can also filter the logs in the viewer by level or by route if you're interested in specific events.

Other Settings

All other system settings can be modified from the Settings screen (admin->settings). This is the same screen you see at initial setup, and the settings have the same meanings as described in that section.