doc:faq
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revisionNext revisionBoth sides next revision | ||
doc:faq [2019/01/12 17:53] – external edit 127.0.0.1 | doc:faq [2020/03/30 16:27] – [How can I support the FlatPress project?] arvid | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
+ | Here, you find answers to general questions about FlatPress. If you have // | ||
===== What is FlatPress? ===== | ===== What is FlatPress? ===== | ||
+ | FlatPress is a lightweight, | ||
+ | It's best suitable for **personal blogs** or **small business sites**. FlatPress is a **single user system** (see [[doc: | ||
- | FlatPress | + | FlatPress |
- | + | ||
- | + | ||
- | ===== Can I use WordPress themes and plugins right in FlatPress ? ===== | + | |
- | + | ||
- | + | ||
- | Sorry ;) we're thinking about doing miracles, but we're still not ready. | + | |
- | + | ||
- | I will never repeat this enough. **FlatPress IS NOT " | + | |
- | Themes have just nothing to do with WP, so not at all. | + | |
- | + | ||
- | ===== Files for download are .tar.bz2 archives. Can you provide zipped archives? ===== | + | |
- | + | ||
- | Maintaining packages for all the OS's is quite complicated. Why shouldn' | + | |
- | Bzip2 has a great compression for text files and you can easiliy expand it on every platform. | + | |
- | + | ||
- | On Windows I'd suggest the opensource [[http:// | + | |
- | + | ||
- | If you'll use one of these apps, packages won't stand on my nerves and I will have much more time to work at the development ;) | + | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | ===== What is BBCode? ===== | + | |
- | + | ||
- | See: [[http:// | + | |
- | + | ||
- | ===== Which codes are implemented ? ===== | + | |
- | + | ||
- | See: [[doc: | + | |
- | + | ||
- | ===== How is BBCode implemented ? ===== | + | |
- | + | ||
- | Using this great class: [[http:// | + | |
- | + | ||
- | ===== How do I import my old SPB entries in FP ? ===== | + | |
- | + | ||
- | Usually is just a matter of copying you content/ and images/ into your fp-content/ directory. I'd anyway suggest you to convert you're entries to the UTF-8 encoding (see next question). | + | |
- | + | ||
- | ===== Why do I see some strange characters in my old entries? ===== | + | |
- | + | ||
- | Maybe you didn't convert them from iso-8859-15 to utf-8 | + | |
- | Please have a look here: [[http:// | + | |
- | You can always choose a different encoding from the Admin Panel (Config), but I always suggest the conversion. UTF-8 allows | + | |
- | + | ||
- | If you are trying to convert your files after you already installed FP, please delete the files in fp-content/ | + | |
- | + | ||
- | **If you have this issue with just a few characters**, | + | |
- | + | ||
- | + | ||
- | ===== I'm used to SPB blocks; how can I customize them ? ===== | + | |
- | + | ||
- | Blocks in FP are very different from the ones you used to see in SPB. If you want to create a **text sidebar block** as you used to do in SPB the procedure may look a little more complicated, | + | |
- | + | ||
- | In FP, create a new **static page** (see below) and choose a name for it (not the title, I'm talking about the little text box at the bottom of the editor) and choose a name you like. For instance, " | + | |
- | + | ||
- | Now insert a new **blockparser** where you want your block to appear. Blockparser is the plugin which parses (i.e. reads) a static page and treats it as the content of a block. | + | |
- | syntax for the widget config: | + | |
- | + | ||
- | < | + | |
- | // [...] here would be preceding lines | + | |
- | ' | + | |
- | ' | + | |
- | // [...] // lines that follow | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | so ' | + | |
- | + | ||
- | Save the config, you should see it after the next page refresh (click any link). | + | |
- | + | ||
- | See also here [[http:// | + | |
- | + | ||
- | + | ||
- | ===== 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 :) | + | |
- | + | ||
- | ===== 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. 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 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 | + | |
- | for instance: | + | |
- | + | ||
- | < | + | |
- | [list] | + | |
- | [*][url=static.php? | + | |
- | [*][url=static.php? | + | |
- | [/list] | + | |
- | </ | + | |
- | + | ||
- | + | ||
- | ===== 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 '' | + | |
- | + | ||
- | Generally in themes you have one ore more predefined widget bars. Usually you have at least the '' | + | |
- | + | ||
- | 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 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). | + | |
- | + | ||
- | + | ||
- | + | ||
- | ===== Are multiple users supported? ===== | + | |
- | + | ||
- | + | ||
- | 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... | + | |
- | + | ||
- | + | ||
- | ===== Why is the installer kidding me? ===== | + | |
- | + | ||
- | + | ||
- | Because I'm evil ! | + | |
- | ===== I've lost my password! | + | ===== Is FlatPress just WordPress without database? |
+ | Important to know: FlatPress is not " | ||
+ | Themes have just nothing to do with WP, not at all. | ||
+ | ===== What's the philosophy of the FlatPress project? ===== | ||
+ | ==== Release cycle ==== | ||
+ | FlatPress is around since 2006, the software is mature and well-tested. And yet, we're still in Version 1.1 (as of Jan 2020). This shows we don't stuff billions of features in our software and publish new releases every week. | ||
+ | FlatPress is meant to be a stable software without surprises. | ||
- | Delete **%%setup.lock** from fp-content/ backup your fp-content/ | + | ==== FlatPress |
+ | FlatPress is free software maintained by voluntary developers in their free time. We don't get (or want) money for FlatPress. Free time is always rare, so we are aware we can't fix every reported bug within hours. | ||
- | ===== I've found a bug! ===== | + | Luckily, we have a great community that helps us with testing, coding, and supporting each other. **This open and friendly spirit is the heart of FlatPress.** You are warmly invited to be part of it! |
+ | ==== Motivation for FlatPress ==== | ||
+ | === Why self-hosted? | ||
+ | Why should one even use a self-hosted blogging system in times of huge easy-to-use platforms like Facebook, Instagram and Twitter? Why hosting the comments for yourself when you could do so with Disqus? | ||
- | First of all, think of it twice. Done? Think again. :D Is it really a bug or a non-implemented-feature? | + | * FlatPress serves those who want to **stay independent** from these services. If you blog on such a platform and it shuts down, your blog is gone. If they think you violate their Terms of Service, your blog is gone. You may think of many other unwanted dependencies. |
- | A bug is behavior you wouldn' | + | * FlatPress serves those who want to **stay in control** of what their blog does. Those who don't like their blog to load dozends of frameworks, images and other stuff from many different CDNs without knowing what their visitors finally get served. |
- | 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. | + | * And FlatPress serves those who want to **customize the blog** to their needs. Not happy with the design? Create an own theme! A functionality |
- | **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. | + | |
- | ===== Can I buy you a beer? ===== | + | === Why flat-file? |
+ | A personal blog in reasonable size is just not the kind of application that would need a database beneath it. Our project site [[https:// | ||
+ | * FlatPress is **easily backed up** just by copying its directory. And if something goes wrong, just delete it on the server and copy back the backup. | ||
+ | * Because FlatPress works without a database, it eliminates a whole category of possible security problems. That makes it **more secure**. | ||
+ | ===== How can I support the FlatPress project? ===== | ||
+ | Glad you ask, thanks for caring! :) In fact, there a are many ways to contribute to FlatPress. | ||
- | You can buy me two! | + | ==== As a coder ==== |
+ | Found a bug? Built a plugin? Designed a theme? Want to propose a new feature? Let us know! | ||
+ | * Open issues or pull requests [[https:// | ||
+ | * Publish your plugins and themes on our wiki: Plugins go [[res: | ||
+ | ==== As a user ==== | ||
+ | Even if you aren't a programmer, you can easily support our project. | ||
+ | * If you have **suggestions**, | ||
+ | * **Show off your blog sites** [[https:// | ||
+ | * **Spread the word: | ||
+ | * Tell the people you use FlatPress by leaving the " | ||
+ | * If you are happy with FlatPress, tell your friends on your favourite social network. | ||
+ | * If you know a software archive or a CMS compare site that does not have FlatPress, tell them! Ask your web hosting provider if they’d like to offer FlatPress in their software installer. Recommend FlatPress to people asking you for an easy-to-use blogging engine. | ||
+ | * Sometimes, we ask for intensive **testing** before releasing a new version. Take part in it and tell us what you think. | ||
+ | * To **keep up to date**, check out flatpress.org once in a while. You may also subscribe to [[http:// |
doc/faq.txt · Last modified: 2022/05/04 21:40 by arvid