Version originale de la documentation (French original version)
Quinoa is a static weblog engine that used a BSD Makefile to work.
Stay tuned to Quinoa weblog.
You can contact me to this address.
This software is published under GNU Affero General Public License 3.0.
Some stats about project could be found on Ohloh.net.
Quinoa is a subproject of BlogBox that aims to give user a better way to host a blog at home.
Some programs on which quinoa depends:
- pmake or bmake
- markdown command
- lua 5.1 and earlier
So use your distribution package manager to install them. For an example on Debian and derivated, it would be:
apt-get install pmake markdown lua5.1
For other distribution, please have a look on your distribution's forum/IRC/community. They will enjoy helping you.
There is 2 ways to install Quinoa on your computer:
- Using last stable version by fetching a tarball (recommanded)
- Using current developement version by using a repository (for advanced user only)
Just download last version on official website: http://quinoa.e-mergence.org/.
For an example 0.2.1 version.
Then extract tarball's content into a directory.
You have to use git command. If you don't know what it is, have a look to Git SCM website.
After git installation, go to a working directory and do this:
git clone git://gitorious.org/quinoa/master.git quinoa_dev
This will fetch quinoa repository and add files into quinoa_dev directory.
Note: Using git is useful to easily update quinoa. In fact:
git pull git://gitorious.org/quinoa/master.git
will update your quinoa.
WARNING: You have to always backup your files! This method could delete some changes you made previously.
No special configuration required. Check that quinoa.rc file is present. Otherwise copy quinoa.rc.example file or rename it to quinoa.rc.
The first time you use Quinoa you don't have any configuration file. An example is available in quinoa.rc.example. Copy it to quinoa.rc to permit Quinoa to work.
For more information please read The quinoa.rc configuration file section.
The way to create content depends on your version.
To know your current version, just use this command:
pmake version
If an error occured like pmake: don't know how to make version. Stop, then you are under 0.2.1 version.
Go to tools directory and launch create_post.sh script like this:
cd tools
./create_post.sh
and answer to all given questions. It will generate some files needed by Quinoa.
Note that Quinoa use the markdown format for its quotes.
Use this command:
pmake add
and answer to all given questions. It will generate some files needed by Quinoa.
Note that Quinoa use the markdown format for its quotes.
If you want to add some static files, just add them to the static directory. They will be copied in destination directory.
This one is named special because it can contain some file you have to create in order to activate a functionality:
- about.md : Is the content of an about's page about your website. It will add an item in the website main menu (If your theme support it.)
- sidebar.md : Add a sidebar on your website. The theme have to support this function.
- introduction.md : Display this file's content as an introduction on all your website's pages. This could change regarding the choosen theme.
- footer.md : Display this file's content as a footer on all your website's pages. This could change regarding the choosen theme.
After having created quinoa.rc (from quinoa.rc.example) and having created some quotes, just do this:
pmake
It will generate a Quinoa weblog to the pub directory.
Note: pmake is for Debian like distribution. For other distributions, I suggest you to use bmake.
The result is compatible with all HTML servers. In fact you could probably use result with your website provider. You just have to upload all files from pub directory to your provider's web directory.
If you launch Quinoa on you own server or probably on provider ' server, you should be capable to use install script automation. Just launch it as:
pmake install
...and it will copy all files to ~/public_html directory.
WARNING: This will erase all files from public_html directory!
Note: You can customize the destination by changing quinoa.rc file espacially the given line :
INSTALLDIR=${HOME}/public_html
Then relaunch pmake install to recompile the weblog.
To publish your blog to a remote computer you have to:
- have an SSH access to the remote machine
- have rsync program
- configure PUBLISH_DESTINATION in quinoa.rc file
- launch publish command
That's all!
Note that PUBLISH_DESTINATION looks like:
myRemoteUser@remoteDomain.tld:/myhomedirectory/public_dir
Once having complete this variable in quinoa.rc file, just launch:
pmake publish
For developers: You can also edit tools/publish.sh file and change script content to you own code.
To make easier the theme creation you can use this command:
pmake theme name="myTheme"
where myTheme is to replace by your own theme name.
Note: This exploit a theme called Base as example.
A simple way to translate Quinoa to your language is to copy the lang/translate.en file to another translation file. For an example, for french (with fr code), you can copy lang/translate.en to lang/translate.fr and change values. Then just change BLOG_LANG option in quinoa.rc file.
Perhaps would you backup some important files in Quinoa? It's possible via backup command. Just launch it like this:
pmake backup
Requirements:
- tar
- gzip
Files saved:
- quinoa.rc
- static directory
- special directory
- db directory
- src directory
- the directory that contains the choosen theme (for an example templates/default/)
Result: This will create a tarball named YYYYMMDD_quinoa.tar.gz in mbackup directory (for an example 20120823_quinoa.tar.gz). You can so backup your Quinoa each day for an example.
You can customize (in your quinoa.rc file):
- the backup directory by using BACKUPDIR option
- the compression tool by using COMPRESS_TOOL option. For an example with gzip.
- the backup file extension by using COMPRESS_EXT. For an example with .gz (don't forget the point char).
Sources are available:
This file is the documentation. You can read it on github or simply generate an HTML file with this command:
pmake doc
Note: pmake command is for Debian like. For other distribution, use bmake instead of pmake.
In Quinoa you can publish early quotes. To do that metadata file should have a timestamp superior to current's one when you generate the weblog.
For an example we are 2013, the 6th march. 12:30:00. The timestamp is : 1362569400. Your post (situated in the db directory) have to have a timestamp inferior to current's one (1362569400).
Here is some options you can change:
- BLOG_TITLE: Title of your weblog
- BLOG_SHORT_DESC: A short description of your weblog
- BLOG_DESCRIPTION: A long description of your weblog
- BLOG_LANG: your language code. Note that file lang/translate.YOUR_LANGUAGE_CODE should exists. For an example if I set this parameter to en, a lang/translate.en file should exists!
- BLOG_CHARSET: your encoding configuration. Should be something like UTF-8 or ISO-8859-1. If you don't know what's this option, just let it to UTF-8.
- BLOG_URL: absolute URL of your blog. For an example http://quinoa.e-mergence.org/.
- RSS_FEED_NAME: Title for the RSS Feed
- MAX_POST: Max post that would be showed on home page
- MAX_POST_LINES: Number of lines that should be shown on Homepage. If set to 0 or not referenced in quinoa.rc file, then quotes are fully shown.
- DATE_FORMAT: Date format displayed for each post. Please see man date's page for more information.
- SHORT_DATE_FORMAT: Short date format that would be used on the post list page. Please see man date's page for more information.
- INDEX_FILENAME: Name given to all index'pages. For an example with INDEX_FILENAME = mainpage, post list page will be named mainpage.html.
- PAGE_EXT: suffix that all page will have. DO NOT FORGET TO ADD A POINT BEFORE SUFFIX. For an example, with PAGE_EXT = .html, all pages will be under the form: index.html.
- ABOUT_FILENAME: As described, this is the about's filename. If you set it to "about" for an example, you have to create a "about.md" file into special directory in order to have an about's page. If you change it to "toto", so you have to create a toto.md file into special directory.
- POSTDIR_NAME: The name you want to be displayed in URL when a user go to post list. For an example, if you set it to "myquotes": http://quinoa.e-mergence.org/myquotes/ will display all you quotes. This is useful for others languages.
- TAGDIR_NAME: Same behaviour as POSTDIR_NAME, but for tags. Change it to "mytags" for an example, and you will have URLs like this: http://quinoa.e-mergence.org/mytags/ to display tag list.
- THEME: Name of the theme you want to be used. All themes are available in template directory. Each theme have its own directory. For an example, "default" theme have its template/default directory.
- FLAVOR: This name will be used to select a color from your theme (if exists)
- BACKUPDIR: Name of directory where backup command will save all files.
- SIDEBAR_FILENAME: As described, name of sidebar file that would be used to create a sidebar. If you set it to "sidebar" for an example, you have to create a "sidebar.md" file into special directory in order to have this sidebar. Note that your theme should support sidebars!
- SIDEBAR: If set to 1, so activate a sidebar on Quinoa. Note that your theme should support sidebars!
- PUBLISH_DESTINATION: Full address from where to send files in order to publish them.
- PUBLISH_SCRIPT_NAME: script filename used to send files from pub directory to a destination filled in PUBLISH_DESTINATION variable.
- SEARCH_BAR: If set to 1, activate a search bar on Quinoa. Note that your theme should support search bar!
- MAX_RSS: Max RSS quotes that would be fetch from your users.
- JSKOMMENT : If set to 1, this activate a comment system on Quinoa. Note that your theme should support comment system. Warning: default server is jskomment.appspot.com which doesn't guarantee a long backup of your comments. More info are available on jskomment project installation page (fr).
- JSKOMMENT_CAPTCHA_THEME (optional): Define a theme regarding reCaptcha page for Catpcha in JSKOMMENT comment system
- JSKOMMENT_URL (optional): Define a JSKOMMENT server on which send comments. By default http://jskomment.appspot.com/.
- JSKOMMENT_MAX (optional): Define a limit for displayed comments for JSKOMMENT comment system. By default 2.
- ELI_USER: If set, this activate a badge for identica. Note that your theme should support ELI widget. By default this functionality use IDENTICA's API.
- ELI_TYPE (optional): Change this to "group" to follow a group instead of a user on IDENTICA. By default "user".
- ELI_MAX (optional): Permit to choose how many statuses to display. On identica, this couldn't bypass the default 20 items. Default value: 5.
- ELI_API (optional) : Access to your StatusNet API system.
- INSTALLDIR : Permit to choose a target directory when using install.sh script (Read more in Publish result to the web chapter)
- COMPRESS_TOOL (optional) : Shell tool used for backup compression via backup command (Cf. Backup section). Example : gzip.
- COMPRESS_EXT (optional) : Backup file extension. Warning: do not forget the point char. Example: .gz.