From 2f1f18072dfca03b9273cb00bb162fbcecd6779d Mon Sep 17 00:00:00 2001 From: Thorsten Rinne Date: Sat, 10 Jan 2015 22:10:44 +0100 Subject: [PATCH] Fixed minor layout issues --- app/templates/pages/contribute.hbs | 17 +- app/templates/pages/docs/2.6.md | 616 +++++++++++++------------- app/templates/pages/docs/2.7.md | 98 ++-- app/templates/pages/old-downloads.hbs | 2 +- 4 files changed, 366 insertions(+), 367 deletions(-) diff --git a/app/templates/pages/contribute.hbs b/app/templates/pages/contribute.hbs index 17990a5..24cef3c 100644 --- a/app/templates/pages/contribute.hbs +++ b/app/templates/pages/contribute.hbs @@ -34,12 +34,14 @@ layout: none ensures that the code remains Open Source and under the MPL 2.0 license. All contributions will be added to the changelog and on the phpMyFAQ website.

+

How to contribute?

Contributing to phpMyFAQ is quite easy - just fork the project on - GitHub, work on your copy and - send pull requests. + GitHub, work + on your copy and send pull requests.

+

Setup a phpMyFAQ development environment

Before working on phpMyFAQ, setup an environment with the following software: @@ -71,6 +73,7 @@ layout: none It's easier to use our Vagrant/Puppet development box, you can download the box at Github.

+

Configure your Git installation

Set up your user information with your real name and a working e-mail address: @@ -78,6 +81,7 @@ layout: none 

$ git config --global user.name "Your Name"
 $ git config --global user.email you@example.com
 $ git config core.autocrlf # if you're on Windows
+

How to get the phpMyFAQ source code?

Clone your forked phpMyFAQ repository locally: @@ -92,6 +96,7 @@ $ git remote add upstream git://github.com/thorsten/phpMyFAQ.git Please check our coding standards before sending patches or pull requests.

+

Fetch 3rd party libraries and install phpMyFAQ

After cloning your forked repository, you have to fetch the 3rd party libraries used in phpMyFAQ: @@ -108,7 +113,8 @@ $ bower install If you changed some JavaScript code, you have to merge the .js files into one with the following grunt task:

-
$ grunt
+ 
$ grunt
+

Rebase your Patch

Before submitting your patch, please update your local branch: @@ -146,8 +152,9 @@ $ git rebase 2.8

Proxy issues with Bower

- If you are behind a non-transparent proxy, add 'proxy' and ''https-proxy' settings to ~/.bowerrc. - See http://bower.io/docs/config/. + If you are behind a non-transparent proxy, add 'proxy' and ''https-proxy' settings to + ~/.bowerrc. See this page + for more information.

Proxy issues with Composer

diff --git a/app/templates/pages/docs/2.6.md b/app/templates/pages/docs/2.6.md index 6c9a90a..888495c 100644 --- a/app/templates/pages/docs/2.6.md +++ b/app/templates/pages/docs/2.6.md @@ -8,12 +8,10 @@ layout: docs.hbs 1. **[Introduction](#1)** - 1. [License](#1a) 2. [Support](#1b) 3. [Copyright](#1c) 2. **[Installation](#2)** - 1. [Requirements](#2a) 2. [Preparations](#2b) 3. [Install-Script](#2c) @@ -29,13 +27,11 @@ layout: docs.hbs 13. [Spam protection](#2m) 14. [Attachments](#2n) 3. **[Upgrading](#3)** - 1. [Upgrading from phpMyFAQ 2.0.x](#3a) 2. [Upgrading from phpMyFAQ 2.5.x](#3b) 3. [Upgrading phpMyFAQ 2.6.x versions](#3c) 4. [Modifying templates for phpMyFAQ 2.6.x](#3d) 4. **[Front-end](#4)** - 1. [Change languages](#4a) 2. [RSS Feeds](#4b) 3. [Advanced search](#4c) @@ -48,7 +44,6 @@ layout: docs.hbs 10. [Internal references](#4j) 11. [Public user registration](#4k) 5. **[Administration](#5)** - 1. [User Administration](#5a) 2. [Group Administration](#5b) 3. [Category Administration](#5c) @@ -61,15 +56,12 @@ layout: docs.hbs 10. [Backup](#5j) 11. [Configuration](#5k) 6. **[Customizing phpMyFAQ 2.5.x](#6)** - 1. [The file template/default/index.tpl](#6a) 2. [The file template/default/style.css](#6b) 3. [More Templates](#6c) 7. **[Customizing phpMyFAQ 2.6.x](#7)** - 1. [Creating custom layout](#7a) 8. **[Developer documentation](#8)** - 1. [rest/json API](#8a) 9. **[One more thing](#9)** @@ -161,8 +153,7 @@ phpMyFAQ addresses a database system via PHP. In order to install it you will need a web server that meets the following requirements: * **[PHP](http://www.php.net)** - - * from version 5.2.0 (recommended: latest PHP 5.x) + * from version 5.2.0 (recommended: latest PHP 5.x) * register_globals = off (recommended) * safe_mode = off (recommended) * memory_limit = 64M @@ -171,28 +162,22 @@ phpMyFAQ addresses a database system via PHP. In order to install it you * JSON support * Filter support * SPL support -* **Web server** ([Apache](http://httpd.apache.org) - 1.3/2.0/2.2 or [lighttpd](http://www.lighttpd.net) 1.0+ or - [IIS](http://www.microsoft.com/) 5.0+) +* **Web server** + * [Apache](http://httpd.apache.org) 1.3/2.0/2.2 + * [lighttpd](http://www.lighttpd.net) 1.0+ + * [IIS](http://www.microsoft.com/) 5.0+ * **Database server** - - * [MySQL](http://www.mysql.com) 4.1.x and 5.x with the - MySQL extension (recommended: 5.1.x) - * [MySQL](http://www.mysql.com) 4.1.x and 5.x with the - MySQLi extension (recommended: 5.1.x) - * [PostgreSQL](http://www.postgresql.org) 7.2+, 8.x - (recommended: latest 8.x) + * [MySQL](http://www.mysql.com) 4.1.x and 5.x with the MySQL extension (recommended: 5.1.x) + * [MySQL](http://www.mysql.com) 4.1.x and 5.x with the MySQLi extension (recommended: 5.1.x) + * [PostgreSQL](http://www.postgresql.org) 7.2+, 8.x (recommended: latest 8.x) * [Sybase](http://www.sybase.com) - * [Microsoft SQL Server](http://www.microsoft.com/sql/) - 2000, 2005, 2008 - * [IBM DB2 Universal - Database](http://www-306.ibm.com/software/data/db2/) 8.2.x, 9.1.x, [ - IBM Cloudscape](http://www-306.ibm.com/software/data/cloudscape/), and [ - Apache Derby](http://db.apache.org/derby/) + * [Microsoft SQL Server](http://www.microsoft.com/sql/) 2000, 2005, 2008 + * [IBM DB2 Universal Database](http://www-306.ibm.com/software/data/db2/) 8.2.x, 9.1.x, + [IBM Cloudscape](http://www-306.ibm.com/software/data/cloudscape/), and + [Apache Derby](http://db.apache.org/derby/) * [SQLite](http://www.sqlite.org) * [MariaDB](http://montyprogram.com/mariadb/) 5.x (experimental) - * [Firebird](http://www.firebirdsql.org) / - [Interbase](http://www.codegear.com/products/interbase) (experimental) + * [Firebird](http://www.firebirdsql.org) / [Interbase](http://www.codegear.com/products/interbase) (experimental) * correctly set: access permissions, owner, group You can only run phpMyFAQ successfully, when the PHP directive safe_mode is @@ -206,7 +191,7 @@ In case PHP runs as module of the Apache, you will have to be able to do a You can determine which versions your web server is running by creating a file called **info.php** with the following content: - 
<?php phpinfo(); ?>
+ Upload this file to your webspace and open it using your browser. The installation-script checks which version of PHP is installed on your server. @@ -224,7 +209,7 @@ phpMyFAQ uses a WYSIWYG on-line editor. It uses a non-standard feature If you're using _lighttpd_ you have to set the following configuration: - 
cgi.fix_pathinfo 1
+ cgi.fix_pathinfo 1 [back to top](#top) @@ -235,21 +220,21 @@ If you're using _lighttpd_ you have to set the following configuration: Please unzip the downloaded archive on your hard disk. You can modify the layout of phpMyFAQ using templates. A description of - how this is done can be found [below](#6). Copy all unzipped files - to your web server in a directory using FTP. A good choice would be the - directory **faq/**. +how this is done can be found [below](#6). Copy all unzipped files +to your web server in a directory using FTP. A good choice would be the +directory **faq/**. - **Important:** +**Important:** - Writing permission for your script is needed in this directory to be able to - configure the file **database.php** during installation. This is the - case if you're running PHP as CGI or as mod_php with disabled safe-mode. The - installation script will stop when your web server isn't configured as needed. +Writing permission for your script is needed in this directory to be able to +configure the file **database.php** during installation. This is the +case if you're running PHP as CGI or as mod_php with disabled safe-mode. The +installation script will stop when your web server isn't configured as needed. It might help to set chmod 777 to the whole phpMyFAQ directory to avoid - problems during the installation. If you're running a very restrictive mod_php - installation you should keep the chmod 777 for the following files and - directories even after the successful installation: +problems during the installation. If you're running a very restrictive mod_php +installation you should keep the chmod 777 for the following files and +directories even after the successful installation: * the file **database.php** in the directory **config/*** the directory **attachments/** * the directory **data/** @@ -258,7 +243,7 @@ It might help to set chmod 777 to the whole phpMyFAQ directory to avoid All other directories shouldn't be world-writable for your own security. The database user needs the permissions for CREATE, DROP, ALTER, INDEX, - INSERT, UPDATE, DELETE and SELECT on all tables in the database. +INSERT, UPDATE, DELETE and SELECT on all tables in the database. [back to top](#top) @@ -268,7 +253,7 @@ The database user needs the permissions for CREATE, DROP, ALTER, INDEX, Open your browser and type in the following URL: - 
http://www.example.com/faq/install/setup.php
+ http://www.example.com/faq/install/setup.php Substitute **www.example.com** with your actual domain name. When the site is loaded enter the address of your database server (e.g. @@ -299,20 +284,18 @@ When using multiple FAQs you need to install them independently into You can enter the public area of your FAQ by entering - 
http://www.example.com/faq/index.php
+ http://www.example.com/faq/index.php into your browser's address field. Your FAQ will be empty and presented - in the the standard layout. +in the the standard layout. To configure phpMyFAQ point your browser to - 
http://www.example.com/faq/admin/index.php
+ http://www.example.com/faq/admin/index.php -Use the username **admin** and your selected password for your - first login into the admin section. +Use the username **admin** and your selected password for your first login into the admin section. -Some variables that doesn't change regularly, they can be edited in the file - _config/constants.php_. You can change the +Some variables that doesn't change regularly, they can be edited in the file _config/constants.php_. You can change the * the time zone of your server (default: "Europe/Berlin") * the timeout in the admin section (default: 30 minutes) @@ -322,12 +305,9 @@ Some variables that doesn't change regularly, they can be edited in the file * the number of records in the Top10 (default: 10) * the number of latest records (default: 5) * the number of open questions in the RSS feed (default: 50) -* flag with which Latest and Top Ten RSS feeds will be forced to use the - current PMF SEO URL schema (default: true) -* flag with which Google site map will be forced to use the current PMF - SEO URL schema (default: true) -* flag with which Yahoo site map will be forced to use the current PMF - SEO URL schema (default: true) +* flag with which Latest and Top Ten RSS feeds will be forced to use the current PMF SEO URL schema (default: true) +* flag with which Google site map will be forced to use the current PMF SEO URL schema (default: true) +* flag with which Yahoo site map will be forced to use the current PMF SEO URL schema (default: true) * the number with which the Tags Cloud list is limited to (default: 50) * the number with which the Auto-complete list is limited to (default: 20) @@ -338,9 +318,9 @@ Some variables that doesn't change regularly, they can be edited in the file **2.e. Notes regarding the search-function** The boolean full-text search will only work with MySQL and if there are some - entries in the database (5 or more). The term you are looking for should also - not be in more than 50% of all your entries, or it will automatically be - excluded from search. This is not a bug, but rather a feature of MySQL. +entries in the database (5 or more). The term you are looking for should also +not be in more than 50% of all your entries, or it will automatically be +excluded from search. This is not a bug, but rather a feature of MySQL. [back to top](#top) @@ -348,22 +328,36 @@ The boolean full-text search will only work with MySQL and if there are some **2.f. Automatic content negotiation** -To set the default language in your browser you have to set a variable - that gets passed to the web server. How this is done depends on the browser - you are using. +To set the default language in your browser you have to set a variable that gets passed to the web server. How this is +done depends on the browser you are using. -* Mozilla Firefox -Tools -> Options -> Advanced -> Edit Languages -* Mozilla Seamonkey and later versions
Edit -> Preferences ->
-        Navigator -> Languages
+* Mozilla Firefox + + `Tools -> Options -> Content -> Languages` + +* Mozilla Seamonkey and later versions + + `Edit -> Preferences -> Navigator -> Languages` + * Safari -Safari uses the MacOS X system preferences to determine - your preferred language:
System preferences -> International -> Language
+ + Safari uses the MacOS X system preferences to determine your preferred language: + + `System preferences -> International -> Language` + * Opera -Most versions:
File -> Preferences -> Languages
- Linux/*BSD versions 5.x and 6.x:
File -> Preferences -> Document -> Languages
+ + Most versions: + + `File -> Preferences -> Languages` + + Linux/*BSD versions 5.x and 6.x: + + `File -> Preferences -> Document -> Languages` + * Internet Explorer -Windows:
Tools or View or Extras -> Internet Options -> (General) Languages
+ + `Tools or View or Extras -> Internet Options -> (General) Languages` [back to top](#top) @@ -490,25 +484,24 @@ The IP/Network addresses can be added or removed in the configuration panel **2.n. Attachments** Starting with version 2.6 phpMyFAQ supports encrypted attachments. The - encrypton is done using the [AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard) - algorythm implemented in mcrypt extension (if - avaliable) or with native PHP Rijndael implementation. The key size vary - depending on implementation used and can be max 256 bits long. Use of - mcrypt extension is strongly recommended because of performance reasons, its avaliability is checked - automatically at the run time. +encrypton is done using the [AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard) +algorythm implemented in mcrypt extension (if +avaliable) or with native PHP Rijndael implementation. The key size vary +depending on implementation used and can be max 256 bits long. Use of +mcrypt extension is strongly recommended because of performance reasons, its avaliability is checked +automatically at the run time. See the migration section if you're migrating from earlier versions. Pleale be aware: -* Disabling encryption will cause all files be saved unencrypted. In this - case you'll benefit sparing disk space, because identical files will be - saved only once. -* Do not change the default attachment encryption key once files was uploaded. Doing so will cause all the previously uploaded files to be wrong decrypted. If you need to change the default key, you will have to - reupload all files. -* Always memorize your encryption keys. There is no way to decrypt files without a correct key.* Files are always saved with names based on a virtual hash generated from several - tokens (just like key and issue id etc), so there is no way to asses a file - directly using the name it was uploaded under. +* Disabling encryption will cause all files be saved unencrypted. In this case you'll benefit sparing disk space, + because identical files will be saved only once. +* Do not change the default attachment encryption key once files was uploaded. Doing so will cause all the previously + uploaded files to be wrong decrypted. If you need to change the default key, you will have to reupload all files. +* Always memorize your encryption keys. There is no way to decrypt files without a correct key. +* Files are always saved with names based on a virtual hash generated from several tokens (just like key and issue id + etc), so there is no way to asses a file directly using the name it was uploaded under. * Download continuation isn't (yet?) supported. [back to top](#top) @@ -543,19 +536,19 @@ Upgrading from 2.0.x to 2.6.x is a major upgrade. Please make a full backup Open the following URL in your browser: - 
http://www.example.com/faq/install/update.php
+ http://www.example.com/faq/install/update.php Choose your installed phpMyFAQ version and click the button of the update - script, your version will automatically be updated. You have to update some of - your template files due to the new, enhanced template engine. +script, your version will automatically be updated. You have to update some of +your template files due to the new, enhanced template engine. The update script will move your template files to a folder **backup/** - in the directory **template/**. The default layout will be stored - in the folder **template/default/**. +in the directory **template/**. The default layout will be stored +in the folder **template/default/**. Note: We changed the character set for all languages and templates to - UTF-8. If you notice problems with e.g. German umlauts you have to convert - your templates. +UTF-8. If you notice problems with e.g. German umlauts you have to convert +your templates. [back to top](#top) @@ -574,19 +567,19 @@ Upgrading from 2.5.x to 2.6.x is a minor upgrade. Please make a full backup Open the following URL in your browser: - 
http://www.example.com/faq/install/update.php
+ http://www.example.com/faq/install/update.php Choose your installed phpMyFAQ version and click the button of the update - script, your version will automatically be updated. You have to update some of - your template files due to the new, enhanced template engine. +script, your version will automatically be updated. You have to update some of +your template files due to the new, enhanced template engine. The update script will move your template files to a folder **backup/** - in the directory **template/**. The default layout will be stored - in the folder **template/default/**. +in the directory **template/**. The default layout will be stored +in the folder **template/default/**. Note: We changed the character set for all languages and templates to - UTF-8. If you notice problems with e.g. German umlauts you have to convert - your templates. +UTF-8. If you notice problems with e.g. German umlauts you have to convert +your templates. [back to top](#top) @@ -595,7 +588,7 @@ Note: We changed the character set for all languages and templates to **3.c. Upgrading phpMyFAQ 2.6.x** Updating phpMyFAQ 2.6.x is fairly simple. Via FTP copy all new files from - the phpMyFAQ package **except**: +the phpMyFAQ package **except**: * all files in the directory **config/*** all files in the directory **template/** * the directory **attachments/** @@ -604,13 +597,12 @@ Updating phpMyFAQ 2.6.x is fairly simple. Via FTP copy all new files from Open the following URL in your browser: - 
http://www.example.com/faq/install/update.php
+ http://www.example.com/faq/install/update.php Choose your installed phpMyFAQ version and click the button of the update - script, your version will automatically be updated. +script, your version will automatically be updated. -You can find the changed files between the 2.6.x versions in the file - _docs/CHANGEDFILES_. +You can find the changed files between the 2.6.x versions in the file _docs/CHANGEDFILES_. [back to top](#top) @@ -619,13 +611,13 @@ You can find the changed files between the 2.6.x versions in the file **3.d. Modifying templates for phpMyFAQ 2.6.x** The 2.0.x and 2.5.x templates are mostly compatible with phpMyFAQ 2.6, if your - layout is completely based on CSS, you only have to change the .tpl files listed in - _docs/CHANGEDFILES_. If you need help to integrate phpMyFAQ into your - website feel free to contact us. +layout is completely based on CSS, you only have to change the .tpl files listed in +_docs/CHANGEDFILES_. If you need help to integrate phpMyFAQ into your +website feel free to contact us. Note: We changed the character set for all languages and templates to - UTF-8. If you notice problems with e.g. German umlauts you have to convert - your templates. +UTF-8. If you notice problems with e.g. German umlauts you have to convert +your templates. [back to top](#top) @@ -634,13 +626,13 @@ Note: We changed the character set for all languages and templates to **4. Front-end** The phpMyFAQ front-end has a quite simple default layout. The header has the - main links for the advanced search, add content, ask questions, open questions, - help and contact. On the left side you see the main categories, the instant - response page and the site map. You can also change the current language of the - FAQ, use the search form or the login box if you have a valid user account. On - the right side you see a list of the most popular FAQ records, the latest records, - and the sticky FAQ records. On the pages with the FAQ records you'll see the other - records of the current category and the tag cloud if you're using tagging. +main links for the advanced search, add content, ask questions, open questions, +help and contact. On the left side you see the main categories, the instant +response page and the site map. You can also change the current language of the +FAQ, use the search form or the login box if you have a valid user account. On +the right side you see a list of the most popular FAQ records, the latest records, +and the sticky FAQ records. On the pages with the FAQ records you'll see the other +records of the current category and the tag cloud if you're using tagging. [back to top](#top) @@ -649,21 +641,21 @@ The phpMyFAQ front-end has a quite simple default layout. The header has the **4.a. Change languages** As written above there's a select box for changing the current language. If - you're visiting a phpMyFAQ powered FAQ, the current language will be the one - you're browser is using or the language which was selected by the administrator - of the FAQ. If you change the language you'll see the categories and records of - your chosen language. If there are no entries in this language you'll see no - entries. If you're switching to languages with right to left text direction - (for example Arabic, Hebrew or Farsi) the whole layout will be switching - according to the text direction. +you're visiting a phpMyFAQ powered FAQ, the current language will be the one +you're browser is using or the language which was selected by the administrator +of the FAQ. If you change the language you'll see the categories and records of +your chosen language. If there are no entries in this language you'll see no +entries. If you're switching to languages with right to left text direction +(for example Arabic, Hebrew or Farsi) the whole layout will be switching +according to the text direction. **Note:** phpMyFAQ uses a WYSIWYG on-line editor that has support - for multiple languages. However, phpMyFAQ comes only with English language pack - installed so changing the current language will not change the language of - WYSIWYG editor. If you would like to have WYSIWYG editor in another language, just - download the latest [language pack](http://tinymce.moxiecode.com/download_i18n.php), - extract it and upload the extracted files to admin/editor directory under your - phpMyFAQ's installation directory on your web server. +for multiple languages. However, phpMyFAQ comes only with English language pack +installed so changing the current language will not change the language of +WYSIWYG editor. If you would like to have WYSIWYG editor in another language, just +download the latest [language pack](http://tinymce.moxiecode.com/download_i18n.php), +extract it and upload the extracted files to admin/editor directory under your +phpMyFAQ's installation directory on your web server. [back to top](#top) @@ -793,25 +785,25 @@ On the left column of the default layout the users of the FAQ also have the **5. Administration** The administration of phpMyFAQ is completely browser-based. The admin area - can be found under this URL: +can be found under this URL: - 
http://www.example.com/faq/admin/index.php
+ http://www.example.com/faq/admin/index.php You can also login in the public front-end and after the successful login you'll - see a link to administration back-end, too. +see a link to administration back-end, too. If you have lost your password you can reset it. A new random password will - be generated and sent to you via e-mail. Please change it after your successful - login with the generated password. +be generated and sent to you via e-mail. Please change it after your successful +login with the generated password. After entering your username and password you can log into the system. On - the start page you can see the admin menu on the top, some statistics about visits, - entries and comments in the middle of the page. At the bottom of the main admin - page you'll see a button for version information. If you click on that button - your version of phpMyFAQ will check the latest version number from our website - www.phpmyfaq.de. We do not log anything in this process! You can switch the - current language in the administration back-end and you have an info box about - the session timeout. +the start page you can see the admin menu on the top, some statistics about visits, +entries and comments in the middle of the page. At the bottom of the main admin +page you'll see a button for version information. If you click on that button +your version of phpMyFAQ will check the latest version number from our website +www.phpmyfaq.de. We do not log anything in this process! You can switch the +current language in the administration back-end and you have an info box about +the session timeout. [back to top](#top) @@ -820,22 +812,22 @@ After entering your username and password you can log into the system. On **5.a. User Administration** phpMyFAQ offers a flexible management of privileges (or rights) for different - users in the admin area. To search for a certain user just start typing the username - in the input form and you'll get a list of hits for usernames. It is possible to assign - different privileges to real people (represented by the term users). Those privileges - are very detailed and specific, so that you could allow a certain user to edit but - not to delete an entry. It is very important to contemplate which user shall get which - privileges. You could edit an entry by completely deleting all content, which would - be equivalent to deleting the whole entry. The number of possible users is not limited - by phpMyFAQ. +users in the admin area. To search for a certain user just start typing the username +in the input form and you'll get a list of hits for usernames. It is possible to assign +different privileges to real people (represented by the term users). Those privileges +are very detailed and specific, so that you could allow a certain user to edit but +not to delete an entry. It is very important to contemplate which user shall get which +privileges. You could edit an entry by completely deleting all content, which would +be equivalent to deleting the whole entry. The number of possible users is not limited +by phpMyFAQ. Keep in mind that new users have no privileges at all, you will have to assign - them by editing the user's profile. The _admin_ user cannot be deleted, - nor can the name be changed. +them by editing the user's profile. The _admin_ user cannot be deleted, +nor can the name be changed. A user without any permission in the admin section can still get read access - to categories and records. You can set the permissions on categories and records - in the category and record administration front-ends. +to categories and records. You can set the permissions on categories and records +in the category and record administration front-ends. [back to top](#top) @@ -844,11 +836,11 @@ A user without any permission in the admin section can still get read access **5.b. Group Administration** phpMyFAQ also offers a flexible management of privileges (or rights) for - different groups in the admin area. You can set permissions for groups in the - same way like for users described in the topic above. +different groups in the admin area. You can set permissions for groups in the +same way like for users described in the topic above. Please note that the permissions for a group are higher rated than the permissions - on a user. +on a user. [back to top](#top) @@ -857,12 +849,12 @@ Please note that the permissions for a group are higher rated than the permissio **5.c. Category Administration** phpMyFAQ lets you create different categories and nested sub-categories for - your FAQ. You can also re-arrange your categories in a different order. It is - possible to use various languages per category, too; there's also a front-end about - all translated categories. For accessibility reasons you should add a small description - for every category. If you add a new category, you can set the permissions for - users and groups, and you can bind an administrator to that category. This is - quite nice if you want to share the work in your FAQ between various admin users. +your FAQ. You can also re-arrange your categories in a different order. It is +possible to use various languages per category, too; there's also a front-end about +all translated categories. For accessibility reasons you should add a small description +for every category. If you add a new category, you can set the permissions for +users and groups, and you can bind an administrator to that category. This is +quite nice if you want to share the work in your FAQ between various admin users. [back to top](#top) @@ -871,21 +863,21 @@ phpMyFAQ lets you create different categories and nested sub-categories for **5.d. Record Administration** You can create entries directly in the admin area. Created entries are NOT - published by default. All available entries are listed on the page "edit FAQs". - By clicking on them the same interface that lets you create records will open up, - this time with all the relevant data of the specific entry. The meaning of the - fields is as follows: +published by default. All available entries are listed on the page "edit FAQs". +By clicking on them the same interface that lets you create records will open up, +this time with all the relevant data of the specific entry. The meaning of the +fields is as follows: * **Category** - The place in the FAQ hierarchy where this entry will be published depends on + The place in the FAQ hierarchy where this entry will be published depends on these settings. You can choose one or more categories where to store the entry. If you want to add a FAQ record to more than one category you have to select the categories with your mouse and press the CTRL key. * **Question** - This is the question or headline of your entry.* **Answer** -The content is an answer to the question or a + This is the question or headline of your entry.* **Answer** + The content is an answer to the question or a solution for a problem. The content can be edited with the included WYSIWYG (**W**hat **Y**ou **S**ee **I**s **W**hat **Y**ou **G**et) editor when @@ -893,25 +885,25 @@ The content is an answer to the question or a image manager. * **Keywords** - Keywords are relevant for searching through the database. In case you didn't + Keywords are relevant for searching through the database. In case you didn't include a specific word in the entry itself, but it is closely related to the content you may wish to include it as a keyword, so the entry will come up as a search result. It is also possible to use non-related keywords so that a wrongly entered search will also lead to the right results. * **Tags** - You can add some tags about the current entry here. An Ajax-based auto-completion + You can add some tags about the current entry here. An Ajax-based auto-completion method helps you while typing your tags. * **Author** - It is possible to specify an author for your entry. + It is possible to specify an author for your entry. * **E-Mail** - It is possible to specify the author's e-mail for your entry, but the e-mail + It is possible to specify the author's e-mail for your entry, but the e-mail address won't be shown in the front-end. * **Language** - You can select the language of your entry. By default the selected language saved + You can select the language of your entry. By default the selected language saved in the configuration will be chosen. You can create entries in multiple languages like this: Write an article in English (or any other language) and save it. Now choose _edit records_ and edit your English entry. Change the theme, content @@ -920,60 +912,61 @@ The content is an answer to the question or a your list, having the same id, yet different languages. * **Solution ID** - Every entry generates automatically a so-called solution ID. All records can be + Every entry generates automatically a so-called solution ID. All records can be accessed directly by putting this ID into the search box. * **Active?** - If an entry is "active" it is visible in the public area and will be included in + If an entry is "active" it is visible in the public area and will be included in searches. Is it "deactivated" it will be invisible. Suggested entries are deactivated by default to prevent any abuse. * **Sticky?** - If an entry is "sticky" it is a very important FAQ record and will be shown always on + If an entry is "sticky" it is a very important FAQ record and will be shown always on all pages on the right column. You should mark records as sticky if they are very important for your whole FAQ. Sticky records also appear at the top positions of the lists of FAQ entries. * **Comments?** - If you do not want to allow public comments for this entry you can disable the + If you do not want to allow public comments for this entry you can disable the feature here. * **Revision** - Like a wiki, phpMyFAQ 2 supports revisions of every entry. New revisions won't be + Like a wiki, phpMyFAQ 2 supports revisions of every entry. New revisions won't be created automatically but you can create a new one if you click on "yes". The old revision will be stored in the database and the new current revision will be displayed in the public front-end. You can also bring back old revisions into the front-end if you select an old revision and save them as a new one. * **Date** - You have three options for the FAQ creation date. You can choose to refresh the date of the FAQ entry for every update, or you can keep the date, or you can set an individual date for the FAQ entry. + You have three options for the FAQ creation date. You can choose to refresh the date of the FAQ entry for every + update, or you can keep the date, or you can set an individual date for the FAQ entry. + * **Permissions** - If you add or edit a new entry, you can set the permissions for users and groups. + If you add or edit a new entry, you can set the permissions for users and groups. * **Record expiration time window** - If you need to you can set a time frame from one date to a second date when the + If you need to you can set a time frame from one date to a second date when the FAQ entry should be valid and visible. Before and after this time frame the entry isn't visible and cannot be accessed. * **Date** - Date of the last change. + Date of the last change. * **Changed?** - This field is reserved for comments that can reflect what changes have been applied + This field is reserved for comments that can reflect what changes have been applied to a certain entry. This helps multiple admins to keep track of what happened to the entry over time. Any information entered here will remain invisible in the public area. * **Changelog** - The changelog lists all previous changes, including user and date of change. + The changelog lists all previous changes, including user and date of change. -You can edit and delete all records as well. Please note that old revisions - won't be deleted. +You can edit and delete all records as well. Please note that old revisions won't be deleted. phpMyFAQ lets visitors contribute to the FAQ by asking questions. Every visitor - is able to view these open questions in the public area, and may give an answer. If - you wish to get rid of open questions you can do so using this section. Alternatively - you can take over a question and answer it yourself and hereby add it to the FAQ. +is able to view these open questions in the public area, and may give an answer. If +you wish to get rid of open questions you can do so using this section. Alternatively +you can take over a question and answer it yourself and hereby add it to the FAQ. [back to top](#top) @@ -1019,22 +1012,22 @@ Below every entry visitors have the chance to rate the overall quality of **View Sessions** - This functions lets you keep track of your visitors. Every visitor is assigned an - id when coming to your starting page, that identifies him during his whole visit. - Using the information gathered here you could reconstruct the way visitors use your - FAQ and make necessary adjustments to your categories, content or keywords. +This functions lets you keep track of your visitors. Every visitor is assigned an +id when coming to your starting page, that identifies him during his whole visit. +Using the information gathered here you could reconstruct the way visitors use your +FAQ and make necessary adjustments to your categories, content or keywords. **View Adminlog** - The adminlog allows you to track any actions taken by users in the admin area - of phpMyFAQ. If you feel you have an intruder in the system you can find out - for sure by checking the admin log. +The adminlog allows you to track any actions taken by users in the admin area +of phpMyFAQ. If you feel you have an intruder in the system you can find out +for sure by checking the admin log. **Search statistics** - On the search statistics page you'll get a report about which keywords and how - often your users are searching. This information is split into keywords, the - number of searches for this term, the language and the overall percentage. +On the search statistics page you'll get a report about which keywords and how +often your users are searching. This information is split into keywords, the +number of searches for this term, the language and the overall percentage. [back to top](#top) @@ -1062,11 +1055,11 @@ Using the backup function it is possible to create a copy of the database to * **backup data** - A backup of all **data** will include all entries, users, comments, + A backup of all **data** will include all entries, users, comments, etc. * **backup logs** - The sessions of visits and the adminlog will be saved (i.e. all **LOG** + The sessions of visits and the adminlog will be saved (i.e. all **LOG** files). This information is not necessary for running phpMyFAQ, they serve only statistical purposes. @@ -1078,28 +1071,28 @@ Using the backup function it is possible to create a copy of the database to * **Main FAQ configuration** - Here you can edit the general, the record and spam protection settings of - phpMyFAQ. Should you want to enter multiple email addresses in the configuration - separate them by a comma (","). + Here you can edit the general, the record and spam protection settings of + phpMyFAQ. Should you want to enter multiple email addresses in the configuration + separate them by a comma (","). * **URL Verifier configuration** - The URL Verifier works in the back while you save a new FAQ. It checks your added - FAQ for links and tests the accessibility of all links in your document. In the - URL Verifier configuration you can add, edit and delete special URLs. You can add - a ignore list of URLs and a list of URLs which always return a warning message. + The URL Verifier works in the back while you save a new FAQ. It checks your added + FAQ for links and tests the accessibility of all links in your document. In the + URL Verifier configuration you can add, edit and delete special URLs. You can add + a ignore list of URLs and a list of URLs which always return a warning message. * **Stop Words configuration** - We need stop words for the smart answering feature. If an user is adding a new - question to your FAQ the words will be checked against all FAQs in your database - but without the stop words. Stop words are words with a very low relevance like - the English word "the". + We need stop words for the smart answering feature. If an user is adding a new + question to your FAQ the words will be checked against all FAQs in your database + but without the stop words. Stop words are words with a very low relevance like + the English word "the". * **Interface translation** - With this interface it is possible to edit all available translations of phpMyFAQ. - You only can edit translations when the language file is writable. The interface - checks that for you. If you like you can also send your improved translation to - the phpMyFAQ Team. You cannot change the English translation because this is the - main language file. + With this interface it is possible to edit all available translations of phpMyFAQ. + You only can edit translations when the language file is writable. The interface + checks that for you. If you like you can also send your improved translation to + the phpMyFAQ Team. You cannot change the English translation because this is the + main language file. [back to top](#top) @@ -1128,7 +1121,7 @@ The default layout of phpMyFAQ is saved in the **index.tpl** file. Example: - 
<span class="useronline">{userOnline}</span>
+ {userOnline} The template-parser of the FAQ converts the placeholder _{userOnline}_ to the actual number of visitors on-line. @@ -1171,7 +1164,7 @@ With phpMyFAQ 2.6.x users have even more customization opportunities. The **7.a. Creating a custom layout** - Follow these steps to create a custom template set: +Follow these steps to create a custom template set: * copy the directory templates/default to templates/<custom_template_set> * adjust template files in templates/<custom_template_set> to fit your needs @@ -1205,137 +1198,132 @@ You can call the resources with the following URIs: This method returns the phpMyFAQ version number as string. - * http://www.example.org/phpmyfaq/api.php?action=getVersion (standard) + * http://www.example.org/phpmyfaq/api.php?action=getVersion (standard) * http://www.example.org/phpmyfaq/api/getVersion (rewrite rules enabled) The result will be a string value like this: - 
         {"version":"2.6.0"}
-
+ * **getApiVersion()** - * http://www.example.org/phpmyfaq/api.php?action=getApiVersion (standard) + * http://www.example.org/phpmyfaq/api.php?action=getApiVersion (standard) * http://www.example.org/phpmyfaq/api/getApiVersion (rewrite rules enabled) Returns the version of the API as an integer value. The version number is incremental and will be incremented every time the API changes. - 
         {"apiVersion":1}
-
+ * **search()** - * http://www.example.org/phpmyfaq/api.php?action=search&lang=en&q=phpMyFAQ (standard) + * http://www.example.org/phpmyfaq/api.php?action=search&lang=en&q=phpMyFAQ (standard) * http://www.example.org/phpmyfaq/api/search/en/phpMyFAQ (rewrite rules enabled) You have two variables, _lang_ for the language and _q_ for the search term. You'll get an JSON object as result with the follwing structure: - 
-    [
-        {
-        "id":"1",
-        "lang":"en",
-        "category_id":"15",
-        "question":"Why are you using phpMyFAQ?",
-        "answer":"Because it's cool!",
-        "link":"http://faq.phpmyfaq.de/index.php?action=artikel&cat=15&id=1&artlang=en"
-        },
-        {
-        "id":"13",
-        "lang":"en",
-        "category_id":"5",
-        "question":"Why do you like phpMyFAQ?",
-        "answer":"Because it's cool!",
-        "link":"http://faq.phpmyfaq.de/index.php?action=artikel&cat=5&id=13&artlang=en"
-        }
-    ]
-
+ [ + { + "id":"1", + "lang":"en", + "category_id":"15", + "question":"Why are you using phpMyFAQ?", + "answer":"Because it's cool!", + "link":"http://faq.phpmyfaq.de/index.php?action=artikel&cat=15&id=1&artlang=en" + }, + { + "id":"13", + "lang":"en", + "category_id":"5", + "question":"Why do you like phpMyFAQ?", + "answer":"Because it's cool!", + "link":"http://faq.phpmyfaq.de/index.php?action=artikel&cat=5&id=13&artlang=en" + } + ] + * **getCategories()** - * http://www.example.org/phpmyfaq/api.php?action=getCategories (standard) + * http://www.example.org/phpmyfaq/api.php?action=getCategories (standard) * http://www.example.org/phpmyfaq/api/getCategories (rewrite rules enabled) The result will be a JSON object like the following: - 
-    [
-        {
-        "id":"1",
-        "lang":"en",
-        "parent_id":"0",
-        "name":"phpMyFAQ 2.5",
-        "description":"Everything about phpMyFAQ 2.5",
-        "user_id":"1",
-        "level":0
-        },
-        {
-        "id":"2",
-        "lang":"en",
-        "parent_id":"0",
-        "name":"phpMyFAQ 2.6",
-        "description":"Everything about phpMyFAQ 2.6",
-        "user_id":"1",
-        "level":0}
-    ]
-
+ [ + { + "id":"1", + "lang":"en", + "parent_id":"0", + "name":"phpMyFAQ 2.5", + "description":"Everything about phpMyFAQ 2.5", + "user_id":"1", + "level":0 + }, + { + "id":"2", + "lang":"en", + "parent_id":"0", + "name":"phpMyFAQ 2.6", + "description":"Everything about phpMyFAQ 2.6", + "user_id":"1", + "level":0 + } + ] + * **getFaqs()** - * http://www.example.org/phpmyfaq/api.php?action=getFaqs&lang=en&categoryId=1 (standard) + * http://www.example.org/phpmyfaq/api.php?action=getFaqs&lang=en&categoryId=1 (standard) * http://www.example.org/phpmyfaq/api/getFaqs/en/1 (rewrite rules enabled) You have two variables, _lang_ for the language and _categoryId_ for the category id. You'll get an JSON object as result with the follwing structure: - 
-    [
-        {
-        "record_id":"1",
-        "record_lang":"en",
-        "category_id":"1",
-        "record_title":"Is there life after death?",
-        "record_preview":"Maybe!",
-        "record_link":"\/phpmyfaq\/phpmyfaq\/index.php?action=artikel&cat=1&id=1&artlang=en",
-        "record_date":"20091010175452",
-        "visits":"3"
-        },
-        {"record_id":"2",
-        "record_lang":"en",
-        "category_id":"1",
-        "record_title":"How can I survive without phpMyFAQ?",
-        "record_preview":"It\'s easy!",
-        "record_link":"\/phpmyfaq\/phpmyfaq\/index.php?action=artikel&cat=1&id=2&artlang=en",
-        "record_date":"20091014181500",
-        "visits":"10"
-        }
-    ]
-
+ [ + { + "record_id":"1", + "record_lang":"en", + "category_id":"1", + "record_title":"Is there life after death?", + "record_preview":"Maybe!", + "record_link":"\/phpmyfaq\/phpmyfaq\/index.php?action=artikel&cat=1&id=1&artlang=en", + "record_date":"20091010175452", + "visits":"3" + }, + { + "record_id":"2", + "record_lang":"en", + "category_id":"1", + "record_title":"How can I survive without phpMyFAQ?", + "record_preview":"It\'s easy!", + "record_link":"\/phpmyfaq\/phpmyfaq\/index.php?action=artikel&cat=1&id=2&artlang=en", + "record_date":"20091014181500", + "visits":"10" + } + ] + * **getFaq()** - * http://www.example.org/phpmyfaq/api.php?action=getFaq&lang=en&recordId=1 (standard) + * http://www.example.org/phpmyfaq/api.php?action=getFaq&lang=en&recordId=1 (standard) * http://www.example.org/phpmyfaq/api/getFaq/en/1 (rewrite rules enabled) You have two variables, _lang_ for the language and _recordId_ for the record id. You'll get an JSON object as result with the follwing structure: - 
         {
-        "id":"1",
-        "lang":"en",
-        "solution_id":"1000",
-        "revision_id":"0",
-        "active":"yes",
-        "sticky":"0",
-        "keywords":"",
-        "title":"Is there life after death?",
-        "content":"Maybe!",
-        "author":"Thorsten Rinne",
-        "email":"thorsten@phpmyfaq.de",
-        "comment":"y",
-        "date":"2009-10-10 17:54",
-        "dateStart":"00000000000000",
-        "dateEnd":"99991231235959",
-        "linkState":"",
-        "linkCheckDate":"0"
-        }
-
+ "id":"1", + "lang":"en", + "solution_id":"1000", + "revision_id":"0", + "active":"yes", + "sticky":"0", + "keywords":"", + "title":"Is there life after death?", + "content":"Maybe!", + "author":"Thorsten Rinne", + "email":"thorsten@phpmyfaq.de", + "comment":"y", + "date":"2009-10-10 17:54", + "dateStart":"00000000000000", + "dateEnd":"99991231235959", + "linkState":"", + "linkCheckDate":"0" + } [back to top](#top) diff --git a/app/templates/pages/docs/2.7.md b/app/templates/pages/docs/2.7.md index c7c2c6c..56242b1 100644 --- a/app/templates/pages/docs/2.7.md +++ b/app/templates/pages/docs/2.7.md @@ -148,7 +148,6 @@ phpMyFAQ addresses a database system via PHP. In order to install it you will need a web server that meets the following requirements: * **[PHP](http://www.php.net)** - * from version 5.2.3 (recommended: latest PHP 5.x) * register_globals = off (recommended) * safe_mode = off (recommended) @@ -158,15 +157,12 @@ phpMyFAQ addresses a database system via PHP. In order to install it you * JSON support * Filter support * SPL support - -* **Web server** ( +* **Web server** * [Apache](http://httpd.apache.org) 2.x * [nginx](http://www.nginx.net/) 0.7+ * [lighttpd](http://www.lighttpd.net) 1.0+ * [IIS](http://www.microsoft.com/) 7.0+ - * **Database server** - * [MySQL](http://www.mysql.com) 5.x with the MySQL extension (recommended: 5.5.x) * [MySQL](http://www.mysql.com) 5.x with the MySQLi extension (recommended: 5.5.x) * [PostgreSQL](http://www.postgresql.org) 8.x (recommended: latest 8.x) @@ -190,7 +186,7 @@ by the Apache user. You can determine which versions your web server is running by creating a file called **info.php** with the following content: - `` + Upload this file to your webspace and open it using your browser. The installation-script checks which version of PHP is installed on your server. @@ -207,7 +203,7 @@ You have to enable JavaScript for the Ajax based functions as well. If you're using _lighttpd_ you have to set the following configuration: - `cgi.fix_pathinfo 1` + cgi.fix_pathinfo 1 [back to top](#top) @@ -249,7 +245,7 @@ tables in the database. Open your browser and type in the following URL: - `http://www.example.com/faq/install/setup.php` + http://www.example.com/faq/install/setup.php Substitute **www.example.com** with your actual domain name. When the site is loaded enter the address of your database server (e.g. @@ -280,14 +276,14 @@ your database. You can enter the public area of your FAQ by entering - `http://www.example.com/faq/index.php` + http://www.example.com/faq/index.php into your browser's address field. Your FAQ will be empty and presented in the the standard layout. To configure phpMyFAQ point your browser to - `http://www.example.com/faq/admin/index.php` + http://www.example.com/faq/admin/index.php Use the username **admin** and your selected password for your first login into the admin section. @@ -303,12 +299,9 @@ _config/constants.php_. You can change the * the number of records in the Top10 (default: 10) * the number of latest records (default: 5) * the number of open questions in the RSS feed (default: 50) -* flag with which Latest and Top Ten RSS feeds will be forced to use the - current PMF SEO URL schema (default: true) -* flag with which Google site map will be forced to use the current PMF - SEO URL schema (default: true) -* flag with which Yahoo site map will be forced to use the current PMF - SEO URL schema (default: true) +* flag with which Latest and Top Ten RSS feeds will be forced to use the current PMF SEO URL schema (default: true) +* flag with which Google site map will be forced to use the current PMF SEO URL schema (default: true) +* flag with which Yahoo site map will be forced to use the current PMF SEO URL schema (default: true) * the number with which the Tags Cloud list is limited to (default: 50) * the number with which the Auto-complete list is limited to (default: 20) @@ -329,22 +322,36 @@ The boolean full-text search will only work with MySQL and if there are some ### **2.f. Automatic content negotiation** -To set the default language in your browser you have to set a variable - that gets passed to the web server. How this is done depends on the browser - you are using. +To set the default language in your browser you have to set a variable that gets passed to the web server. How this is +done depends on the browser you are using. + +* Mozilla Firefox -* Mozilla Firefox -Tools -> Options -> Content -> Languages -* Mozilla Seamonkey and later versions`Edit -> Preferences -> - Navigator -> Languages` + `Tools -> Options -> Content -> Languages` + +* Mozilla Seamonkey and later versions + + `Edit -> Preferences -> Navigator -> Languages` + * Safari -Safari uses the MacOS X system preferences to determine - your preferred language:`System preferences -> International -> Language` + + Safari uses the MacOS X system preferences to determine your preferred language: + + `System preferences -> International -> Language` + * Opera -Most versions:`File -> Preferences -> Languages` - Linux/*BSD versions 5.x and 6.x:`File -> Preferences -> Document -> Languages` + + Most versions: + + `File -> Preferences -> Languages` + + Linux/*BSD versions 5.x and 6.x: + + `File -> Preferences -> Document -> Languages` + * Internet Explorer -Windows:`Tools or View or Extras -> Internet Options -> (General) Languages` + + `Tools or View or Extras -> Internet Options -> (General) Languages` [back to top](#top) @@ -372,9 +379,7 @@ Then you have to activate the mod_rewrite support in the admin back-end in the configuration page. You also have to edit the path information for the "RewriteBase". If you installed phpMyFAQ on root directory "/" you should set in - ` RewriteBase / - ` _IIS Web server_ @@ -484,21 +489,20 @@ phpMyFAQ 2.7 supports encrypted attachments. The encryption is done using the [AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard) algorithm implemented in mcrypt extension (if avaliable) or with native PHP Rijndael implementation. The key size vary depending on implementation used and can be max 256 bits long. Use of mcrypt extension is strongly recommended because of -performance reasons, its avaliability is checked automatically at the run time. +performance reasons, its availability is checked automatically at the run time. See the migration section if you're migrating from earlier versions. Please be aware: -* Disabling encryption will cause all files be saved unencrypted. In this case you'll benefit sparing disk - space, because identical files will be saved only once. -* Do not change the default attachment encryption key once files was uploaded. Doing so will cause all the - previously uploaded files to be wrong decrypted. If you need to change the default key, you will have to - re-upload all files. -* Always memorize your encryption keys. There is no way to encrypt files without a correct key. -* Files are always saved with names based on a virtual hash generated from several tokens (just like key - and issue id etc), so there is no way to asses a file directly using the name it was uploaded under. -* Download continuation isn't (yet?) supported. +* Disabling encryption will cause all files be saved unencrypted. In this case you'll benefit sparing disk space, +because identical files will be saved only once. +* Do not change the default attachment encryption key once files was uploaded. Doing so will cause all the previously +uploaded files to be wrong decrypted. If you need to change the default key, you will have to re-upload all files. +* Always memorize your encryption keys. There is no way to encrypt files without a correct key. +*Files are always saved with names based on a virtual hash generated from several tokens (just like key and issue id +etc), so there is no way to asses a file directly using the name it was uploaded under. +* Download continuation isn't (yet?) supported. [back to top](#top) @@ -544,7 +548,7 @@ all files **except**: Open the following URL in your browser: - `http://www.example.com/faq/install/update.php` + http://www.example.com/faq/install/update.php Choose your installed phpMyFAQ version and click the button of the update script, your version will automatically be updated. You have to update a lot of your template files due to the new, enhanced template @@ -574,7 +578,7 @@ you have to delete all files **except**: Open the following URL in your browser: - `http://www.example.com/faq/install/update.php` + http://www.example.com/faq/install/update.php Choose your installed phpMyFAQ version and click the button of the update script, your version will automatically be updated. You have to update a lot of your template files due to the new, enhanced template @@ -597,13 +601,13 @@ Please copy the template file **template/default/indexLogin.tpl** into your temp Upgrading from 2.6.x to 2.7.x is fairly simple. Via FTP copy all new files from the phpMyFAQ package **except**: -* all files in the directory **config/*** all files in the directory **template/** +* all files in the directory **config/*** all files in the directory **template/** * the directory **attachments/** * the directory **images/** Open the following URL in your browser: - `http://www.example.com/faq/install/update.php` + http://www.example.com/faq/install/update.php Choose your installed phpMyFAQ version and click the button of the update script, your version will automatically be updated. You have to update a lot of your template files due to our markup change from XHTML @@ -620,13 +624,13 @@ Please copy the template file **template/default/indexLogin.tpl** into your temp Updating phpMyFAQ 2.7.x is fairly simple. Via FTP copy all new files from the phpMyFAQ package **except**: -* all files in the directory **config/*** all files in the directory **template/** +* all files in the directory **config/*** all files in the directory **template/** * the directory **attachments/** * the directory **images/** Open the following URL in your browser: - `http://www.example.com/faq/install/update.php` + http://www.example.com/faq/install/update.php Choose your installed phpMyFAQ version and click the button of the update script, your version will automatically be updated. @@ -1171,7 +1175,7 @@ including some variables in curly brackets, serving as placeholders for content. Example: -`{userOnline}` + {userOnline} The template-parser of the FAQ converts the placeholder _{userOnline}_ to the actual number of visitors online. diff --git a/app/templates/pages/old-downloads.hbs b/app/templates/pages/old-downloads.hbs index ddd3ae6..b2039af 100644 --- a/app/templates/pages/old-downloads.hbs +++ b/app/templates/pages/old-downloads.hbs @@ -1,6 +1,6 @@ --- title: Museum -description: The Museum: phpMyFAQ downloads of old, unsupported versions. +description: The phpMyFAQ Museum lists downloads of old, unsupported versions canonical: download layout: none ---