osFaq Logo

osFaq

- Open Source Frequently Asked Questions system




osFaq - Frequently Asked Questions system

An easily adaptable FAQ module for websites.

OSI Certified LogoosFaq is a dynamic plugin FAQ-system for php based websites. It can be modified by developers to suit thier own needs. Currently only osTicket is supported by default.

The purpose of this website is to provide documentation about osFaq and links to other sources of related information. osFaq is ideally suited to websites using a header and footer section. Its designed to be seamlessly integrated with minimal effort. Integration packs may be developed to support a number of other websites in the future.

The latest version is osFaq v1.1 ST (download - changelog)


Features:

  • Database driven.
  • Unlimited categories, sub-categories and FAQs.
  • Uses pagination for the admin and user side.
  • Allows uploading one additional document per FAQ (download link displayed below the FAQ).
  • Allows uploading multiple images per FAQ (for use in the FAQ body).
  • Allows users to submit FAQS for approval/rejection.
  • Integrated WYSIWYG editor (optional).
  • Integrated reCAPTCHA bot prevention for user submitted FAQs.
  • Categories and FAQs can be disabled/enabled.
  • Admin and User side search.
  • Keyword highlighting for user search.
  • Featured FAQ block: Display Featured, Popular and New FAQs on osTicket pages.
  • Optional SEO URL system.
  • Built in multilanguage support. English, German and Spanish translations supplied.
  • Built in sitemap.xml generator for search engine robots.
  • RSS feed generator.
  • Install/Update wizard.
  • Open Source Software licensed under the GPLv3
Project Summary - Project News - Downloads - osFaq thread at OsTicket - German Translation - Spanish Translation Pack for v1.0.ST. The latest Spanish and German translations are bundled in the v1.0-ST and v1.1-ST releases.

Announcements

osFAQ v1.1ST available for download

osFAQ v1.1ST is now available for download

Languages include: English, German and Spanish.
All language packs are included in the downloads. Language can be changed during installation or from the osFAQ admin settings page (once installed).

English language by Tim Gall.
German language by Silvio Paschke.
Spanish language by Francisco Flores.

Installation guide.
Change Log.

osFAQ v1.1ST to be released

Hi,
osFAQ v1.1ST is in the testing and finishing-touches phase of development.
It contains a number of fixes and improvements.

Language translations to support the new functionality has been kindly provided by Silvio (German translations) and Francisco (Spanish translations).

The estimated release date is late January 2012 to early February 2012.
PROGRESS UPDATE: Final testing for cross browser compatibility is in progress.
osFaq v1.1-ST will be release this week
(before 04 February 2012).

Final release notifications will be placed on this website, Sourceforge and osTicket when the new version is available for download.

List of changes

Major Changes:

  • Improved main.faq.php (core file, major improvements)
  • Added reCAPTCHA integration to the Faq Submit client side page. reCAPTCHA configs are on the FAQ settings page.
    • Enabled translations for the reCAPTCHA box. Translations for the reCAPTCHA error messages by Silvio (German) and Francisco (Spanish).
    • Built custom themes for reCAPTCHA to closely match the default themes (red, white, blackglass) but in a wider format to support multiple languages without breaking the layout like the default ones from reCAPTCHA tend to for longer amounts of text than the english default.
  • Updated CKEditor to the latest version.
    • Enabled translations for the WYSIWYG editor, to suit the selected language (translations are bundled with CKEditor as part of the official CKEditor release).
    • The WYSIWYG editor makes better use of the stylesheets that are used by the client side.
  • Added admin settings for document uploads.
    • Acceptable file extension list
    • File size limits including an option to add php over ride settings to your .htaccess file for "memory_limit, post_max_size, upload_max_filesize".
    • When editting this setting, a simple diagram is shown graphically displaying how each memory setting relates to the others by hierarchy. For instance, memory_limit affects all other size limits, therefore it should be greater than or equal to the other sizes, etc.
  • Added admin setting to turn FAQ counts on or off (they are shown next to category links).
    • Added admin setting to show the FAQ count as a sum of FAQs including FAQs in subcategories, or just the count of FAQs directly in a category.
  • Added admin setting to show answers on thier own page when displayed, or to expand the FAQ list and display the answer inline.
    • When answers are displayed on thier own page, search-engine sitemaps will contain links to each FAQ.
    • When answers are displayed inline in a list of questions, search-engine sitemaps will contain links to each FAQ-Category.
  • Improved the SEO URL .htaccess modification option to preserve unrelated .htaccess instructions including custom redirects and self removal if the setting is disabled when the .htaccess write-box is selected.
  • Added a field to the document upload FAQ admin section for link text that is used for the readable portion of document links when displayed below a FAQ.
  • Added duplicate document name checking. Duplicate filenames now get a timestamp added to the end to avoid overwriting existing documents.
  • Added a schema file for the SEO-Sitemap in case a person is ever viewing the file. The schema stylesheet controls formatting and styles used for displaying the sitemap file to humans. It has no effect on search-engine indexing bots that read the sitemap.

Minor Changes:

  • Updated the install/upgrade system to support v1.1-ST.
  • Admin FAQ edit page:
    • Set a message on the page to indicate no images exist if none were found after clicking the browse button.
    • Changed the browse-images button to match the image-upload button.
    • Added a margin to the "uploaded-images" (visible after the browse button is pressed).
  • Fixed a html layout error on the Submit-FAQ client-side page after a successful submission.
  • Increased the database field sizes for the FAQ settings page to stop setting "title and description" translations from being truncated when changing languages.
  • Improved the sitemap.xml entry for the main FAQ page to be more SEO friendly when SEO URL's are enabled.
  • Various css improvements to the admin pages of osFAQ.
  • Numerous other minor changes, fixes and improvements.

Other Notes:
Many of the changes that are written for osFaq are driven by ideas, requests and suggestions from the global internet community. I will attempt to put together an acknowledgements page for these people when I have time. It may take a while though as I am quite busy at present due to current and future work obligations. Most of that information is already publicly available online at various locations due to the fairly transparent development process that has been used for osFaq since its beginnings.
I (and no doubt many others) would particularly like to thank the translators since it is a big job and in practice not as straightforward as one might think. These people are an asset to thier countries and opensource principles.

Regards,
Tim Gall - osFAQ design, programming, documentation and support.

osFaq Spanish Translations

Spanish translations for osFaq are available thanks to the efforts of Francisco Flores (SourceForge alias blackpixel1).

They have been packaged into the full download of v1.0 ST and above.
They are also available as a patch pack for people wishing to upgrade existing installs of osFaq v1.0 ST.
You can find the new files at the downloads area.

osFaq v1.0-STABLE is available for download

osFaq v1.0-ST comes with English and German translations.