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:39] – arvid | doc:techfaq [2024/04/07 13:03] (current) – updated for 1.3 arvid | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | Find answers to // | + | Find answers to // |
+ | ===== General technical questions ===== | ||
+ | ==== What is required to run FlatPress? ==== | ||
+ | FlatPress 1.3 will happily run on **any web server that supports PHP from 7.1 to 8.3**.\\ | ||
+ | //The PHP [[https:// | ||
+ | |||
+ | For best results (but not mandatory), the web server should also have a rewrite engine (such as [[https:// | ||
+ | |||
+ | Since all data is stored in files, no database is needed. | ||
+ | |||
+ | ==== How to install FlatPress? ==== | ||
+ | Installing FlatPress [[en: | ||
+ | |||
+ | ==== Are multiple users supported? ==== | ||
+ | The short answer is no. FlatPress is a single user system by design. | ||
+ | |||
+ | You should better ask "can I have more than one user?" | ||
+ | |||
+ | Actually, you can run the installer multiple times; if you choose a different username for each time you run the setup, the old user won't be deleted, and so you'll get one user for each time you run the setup. | ||
+ | |||
+ | 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 the other did (no fix for this at the moment). | ||
+ | |||
+ | ==== I've lost my password! ==== | ||
+ | Delete **%%setup.lock** from fp-content/, | ||
+ | |||
+ | ==== How to backup my FlatPress blog? ==== | ||
+ | There a three things you can do against data loss: Backup, backup, and: backup.\\ | ||
+ | Fortunately, | ||
+ | |||
+ | ==== I've found a bug! ==== | ||
+ | Please do not hesitate to contact the FlatPress team. You may do so on different ways: | ||
+ | * 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 ===== | ===== BBCode ===== | ||
==== What is 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:// | 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: | + | To learn which BBCode tags are implemented in FlatPress, see [[doc: |
==== How is BBCode implemented ? ==== | ==== How is BBCode implemented ? ==== | ||
Line 11: | Line 46: | ||
===== Entries and pages ===== | ===== Entries and pages ===== | ||
- | ===== What is a static page? ==== | + | ==== What is an entry? ==== |
- | A static page is an entry completely unlinked from the normal | + | A blog entry is one content |
+ | * Blog entry example on flatpress.org: https://www.flatpress.org/2019/02/ | ||
- | Where are my static page linked? How do I show them out? | + | ==== 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: | ||
- | SPB creates automatically a list of the static pages you have; however we decided to let the user decide wether to link or not his static page, and this without complex interfaces: just create another static page with your own list of links and bind it to a blockparser widget | + | ===== Plugins ===== |
- | for instance: | + | [[doc: |
- | < | + | [[res: |
- | [list] | + | ==== What is a Plugin? ==== |
- | [*][url=static.php? | + | // In the FlatPress administration area -> Plugin administration: |
- | [*][url=static.php?page=ANOTHER_PAGE]Another Page[/url] | + | |
- | [/list] | + | |
- | </code> | + | |
===== Widgets ===== | ===== Widgets ===== | ||
Line 32: | Line 67: | ||
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 :) | 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 :) | ||
- | ===== How do I add a new widget? | + | ==== How do I add a new widget? ==== |
- | + | {{ : | |
- | 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. | + | |
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 '' | 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 '' | ||
Line 40: | Line 74: | ||
Generally in themes you have one ore more predefined widget bars. Usually you have at least the '' | Generally in themes you have one ore more predefined widget bars. Usually you have at least the '' | ||
- | To add a new widget | + | To add a widget, |
- | + | ==== I have enabled a widget in the plugin panel but I don't see anywhere in my sidebars ==== | |
- | + | ||
- | ===== I have enabled a widget in the plugin panel but I don't see anywhere in my sidebars ===== | + | |
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). | 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, | ||
+ | ==== Approve comments ==== | ||
+ | === 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 and delete it. | ||
+ | ==== 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. | ||
- | ===== Are multiple users supported? | + | ===== Character encoding |
- | + | ||
- | + | ||
- | The short answer is no. | + | |
- | + | ||
- | You should better ask "can I have more than one user?" | + | |
- | + | ||
- | Actually you can run the installer multiple times; if you choose a different username for each time you run the setup, the old user won't be deleted, and so you'll get one user for each time you run the setup. | + | |
- | + | ||
- | 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 the other did (no fix for this at the moment). | + | |
- | + | ||
- | Of course, working on this is on my todo; you might expect to see something more in a few months... | + | |
- | + | ||
- | + | ||
- | ===== I've lost my password! ===== | + | |
- | Delete **%%setup.lock** from fp-content/ backup your fp-content/ | + | |
- | + | ||
- | ===== I've found a bug! ===== | + | |
- | 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 four character encoding standards. [[https:// | ||
+ | To change the character encoding, log in to the administration area and open the " | ||
doc/techfaq.1578170354.txt.gz · Last modified: 2020/01/04 21:39 by arvid