doc:techfaq
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:techfaq [2020/01/04 21:33] – arvid | doc:techfaq [2024/02/18 14:34] (current) – [Approve comments] fraenkiman | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | Find answers to // | + | Find answers to // |
- | ===== What is BBCode? | + | ===== General technical questions |
- | BBCode | + | ==== What is required |
- | To learn which BBCode tags are implemented in FlatPress, see [[doc: | + | FlatPress 1.2.1 will happily run on **any web server that supports PHP from 5.6 to 8.0**.\\ |
- | ===== How is BBCode implemented ? ===== | + | //(Note for future use: FlatPress 1.3 " |
- | Using the great class [[http://www.christian-seiler.de/projekte/php/bbcode/index_en.html|StringParser_BBCode]] by Christian Seiler. | + | |
- | ===== What is a widget? ===== | + | For best results |
- | A wdget is a dynamic component displayed | + | |
- | With " | + | |
- | A widget can then provide more advanced functions than just displaying a list of links (for which I'd suggest | + | |
- | ===== What is a static page? ==== | + | Since all data is stored in files, no database |
- | A static page is an entry completely unlinked from the normal blog entry flux and that can't be commented. It can be reached using the file name you chose when you save it as a parameter for the URL; for instance if you choose MY_PAGE as a file name (not as a title!) you will be able to access your page using %%http:// | + | |
- | Where are my static page linked? How do I show them out? | + | |
- | SPB creates automatically a list of the static pages you have; however we decided | + | ==== How to install FlatPress? ==== |
- | for instance: | + | Installing FlatPress [[en:doc:basic:installation|is very easy]]. |
- | < | + | ==== Are multiple users supported? ==== |
- | [list] | + | The short answer is no. FlatPress is a single user system by design. |
- | [*][url=static.php? | + | |
- | [*][url=static.php?page=ANOTHER_PAGE]Another Page[/url] | + | |
- | [/list] | + | |
- | </ | + | |
+ | You should better ask "can I have more than one user?" | ||
- | ===== How do I add a new widget? ===== | + | Actually, you can run the installer multiple times; if you choose |
- | Add the corresponding plugin both to the plugin list and to the widget list in the section and at the position you want it to go. | + | The drawbacks in this are that every user has administrative powers and there is little or no checks on probable race conditions: for instance, if two you are editing two posts at the same time, strange things may happen: FP may for instance not show one of the posts (clean the cache from the Maintenance panel); if two of you are editing the same posts, the changes of the first to post will be probably lost, overwritten by the changes |
- | Widgets are organized in **groups** or **bars**; every bar can contain any number of widgets. These bars are then displayed on the theme using the special tag '' | + | ==== I've lost my password! ==== |
+ | Delete | ||
- | Generally in themes you have one ore more predefined widget bars. Usually you have at least the '' | + | ==== How to backup my FlatPress blog? ==== |
+ | There a three things you can do against data loss: Backup, backup, | ||
+ | Fortunately, [[en: | ||
- | To add a new widget you add its plugin name to the plugin list in the panel, and the choose one of the groups and add the plugin name to the list as well. As you saw in the blockparser example, some widget may expect you to provide some parameters as well. | + | ==== I've found a bug! ==== |
+ | Please do not hesitate | ||
+ | * If you are familiar with GitHub, [[https:// | ||
+ | * To be sure it's really a bug, open a topic on the [[https:// | ||
+ | FlatPress is an international project, so our preferred language is English. You might find fellow FlatPress users speaking your language on the forum, though :) | ||
+ | See also: https:// | ||
+ | ===== BBCode ===== | ||
+ | ==== What is BBCode? ==== | ||
+ | BBCode is a simple-to-understand markup language that allows you to maintain your blog without knowing about HTML. For a general overview, see [[https:// | ||
+ | To learn which BBCode tags are implemented in FlatPress, see [[doc: | ||
- | ===== I have enabled a widget in the plugin panel but I don't see anywhere in my sidebars ===== | + | ==== How is BBCode implemented ? ==== |
+ | Using the great class [[http:// | ||
- | As we said, Widgets are special plugins providing | + | ===== Entries and pages ===== |
+ | ==== What is an entry? ==== | ||
+ | A blog entry is one content entry of your blog. An entry has a publish date and may be commented | ||
+ | * Blog entry example on flatpress.org: | ||
+ | ==== What is a static page? ==== | ||
+ | A static page is an entry completely unlinked from the normal blog entry flux and that can't be commented. Examples would be the " | ||
+ | * Static page example on flatpress.org: | ||
+ | ===== Plugins ===== | ||
+ | [[doc: | ||
- | ===== Are multiple users supported? ===== | + | [[res: |
+ | ==== What is a Plugin? ==== | ||
+ | // In the FlatPress administration area -> Plugin administration: | ||
+ | ===== Widgets ===== | ||
+ | ==== What is a widget? ==== | ||
+ | A widget is a dynamic component displayed (depending on the theme and on your config) on a topbar, on the right sidebar (default), etc. | ||
+ | With " | ||
+ | A widget can then provide more advanced functions than just displaying a list of links (for which I'd suggest the static+blockparser combo), you may for instance have a widget fetching a displaying an rss feed from an external web page. The only limit is what php can do :) | ||
- | The short answer is no. | + | ==== How do I add a new widget? ==== |
+ | {{ : | ||
- | You should better ask "can I have more than one user?". In this case the answer is "yes, but it's not supported" | + | Widgets are organized in **groups** or **bars**; every bar can contain any number of widgets. These bars are then displayed on the theme using the special tag '' |
- | Actually | + | Generally in themes |
- | The drawbacks in this are that every user has administrative powers and there is little or no checks on probable race conditions: for instance, if two you are editing two posts at the same time, strange things may happen: FP may for instance not show one of the posts (clean | + | To add a widget, just drag'n drop it from the right to the bar you wish it to appear. See screenshot on the right! |
- | + | ==== I have enabled a widget in the plugin | |
- | Of course, working on this is on my todo; you might expect to see something more in a few months... | + | As we said, Widgets are special plugins providing a widget function; by the way FlatPress does not know where you want it to appear, so, once a plugin widget is loaded, you should enable it in the widget panel as well (see the previous question). |
+ | ===== Comments ===== | ||
+ | FlatPress offers very effective mechanisms against spam comments. | ||
+ | Preventively, | ||
- | ===== I've lost my password! | + | ==== Approve comments |
- | Delete **%%setup.lock** from fp-content/ backup your fp-content/ | + | === I have received an e-mail that a comment from me must be approved. |
+ | As of FlatPress 1.3 Andante, comments are blocked by the comment center plugin until you approve or delete them or change the policy. | ||
+ | ==== How to handle spam comments? ==== | ||
+ | To do this, go to Posts -> Manage posts in the administration area. Now find the post that contains spam comments. Now copy the ID of the post (FlatPress 1.3 required). | ||
+ | Now go to the comment center -> Manage comments. Search for the post using the ID. You can now search for the comment, send it to Akismet | ||
+ | ==== Where can I get an Akismet API key? ==== | ||
+ | FlatPress offers you the comment center and [[https:// | ||
+ | After you have received the key, you can enter it in the comment center in the configuration. | ||
- | ===== I've found a bug! ===== | + | ===== Character encoding |
- | First of all, think of it twice. Done? Think again. :D Is it really a bug or a non-implemented-feature? | + | |
- | A bug is behavior you wouldn' | + | |
- | Otherwise, if you save your entry and then you wonder why **it's not playing banjo** in the meantime, that's probably a non-implemented feature. | + | |
- | **NOTE**: the playing banjo is not a short-term feature, we're busy teaching FlatPress how to do a good espresso coffee. FP wants it the American-way. | + | |
+ | ==== Which character encoding standards are supported by FlatPress? ==== | ||
+ | FlatPress currently supports two character encoding standards. [[https:// | ||
+ | To change the character encoding, log in to the administration area and open the " | ||
+ | Although FlatPress with in Greek supports the character encoding [[https:// |
doc/techfaq.1578169998.txt.gz · Last modified: 2020/01/04 21:33 by arvid