[MOD] osFaq: Page 4 - osTicket Forum

[MOD] osFaq

Tim Gall

Helo sir Tim Gall,
I noticed that there is no validation in "add new faq" whenever i tried to submit or preview having an empty question and answer it was still posted.
and also this:
"Enable Client WYSIWYG? true"
"Allow users to submit FAQs for approval? true"
how does it work sir? it seems i can't see where to send faqs for approval (Client logged-in)
and is there anyway only admins can view the faq tab?
thank so much sir

Hi Shinshigumi,

Ill answer what I can now and release an update to cater for the rest.

"Enable Client WYSIWYG?"

This will enable/disable the WYSIWYG (What You See Is What You Get) javascript editor on the client side "Submit FAQ" page. If the WYSIWYG is disabled, a plain text-area will be used instead.

"Allow users to submit FAQs for approval?"

This will enable/disable the link on the client side FAQ pages that allows users to access the submit FAQ page. If this setting is disabled, the link will not appear and the submit-FAQ page will redirect any requests back to the FAQ pages.

NOTE: the client side FAQ answer field (on the Submit-FAQ page) is not validated before being saved in-case the client wants to ask a question they do not know the answer for.

FAQs that are submitted through the client Submit-FAQ page will be saved as disabled (EG: will not be displayed until set to enabled by an admin).

The fastest way to find disabled FAQs is to use the filter area on the FAQ admin page.

Set: "Show all" (to yes) and select "disabled" from the status filter.

To get back to normal view, change "Show all" (to no) and set the status filter back to "Any Status".

--------------------------

I will look into admin side validation and adding an admin setting to choose between Only-Admins or Admins-and-Staff being able to access the FAQ admin area. At present, only Admins can change the osFaq settings or access the upload-cleaner pages. Staff can currently access the FAQ admin and sitemapper pages only.

At the moment there is no requirement for the client to be logged in to access the submit-FAQ page (when its enabled). I will look into adding an admin setting to toggle between allowing "logged in users" or "anonymous users".

Regards,

Tim Gall

osTicket v 1.6 ST (stable)

osFaq is compatible with upgrades from osTicket v 1.6 RC5 to osTicket v 1.6 ST (stable).

If anyone has any problems can they please let me know.

osFaq is currently not compatible with new installs of osTicket v 1.6 ST (stable).

Im working on a new release of osFaq for new installs and will release it as soon as its finished.

Regards,

Tim Gall

osFAQ v1.0.RC5 for osTicket 1.6 STABLE

A new version of osFaq has been released.

The changes are summarised below.

You can download the latest version here: https://sourceforge.net/projects/osfaq/files(https://sourceforge.net/projects/osfaq/files)

CHANGE-LOG for osFaq v1.0.RC5

* Updated the osFaq installer to work with fresh installs of osTicket v1.6 ST (STABLE).

* Fixed admin FAQ form not submitting in IE browsers.

* Fixed admin form button text when the "fancy buttons" option is turned off.

* Added admin side validation for FAQs and FAQ Categories.

* Added an admin setting to choose between Only-Admins or Admins-and-Staff being able to access the FAQ administration area.

* Added an admin setting to toggle between allowing "logged in users" or "anonymous users" to submit new faqs.

* Updated the WYSIWYG editor to the latest version (from v3.0.1 to v3.1.0).

* Modified WYSIWYG admin toolbar button arrangement (removed unused).

* Modified WYSIWYG client toolbar button arrangement (added some more options).

* Updated admin style sheet.

Regards,

Tim Gall

goginet

stuck on install

Hi Tim,

I have a fresh install of the latest osticket - got it all running OK.

Then I uploaded the osfaq files per instructions.

Ran the /faq/setup

It cretaes teh db tables ok, but in step 2 it shows some errors:

-------------------------------------

Warning: file_get_contents(/home/insmalls/webapps/_/include/staff/header.inc.php) : failed to open stream: No such file or directory in /home/insmalls/webapps/support_llr/faq/setup/inc/staff.inc.php on line 27

Warning: file_get_contents(/home/insmalls/webapps/_/include/class.nav.php) : failed to open stream: No such file or directory in /home/insmalls/webapps/support_llr/faq/setup/inc/staff.inc.php on line 29

Staff integration

You need to integrate some code into your staff area so you can administer your FAQ system.

The messages below indicate the state of each check I performed.

1) MISSING: Please make sure the main admin file is uploaded to your osTicket directory like so:

/home/insmalls/webapps/_/scp/faq_admin.php

...

---------------------------------

My install of osticket is in /home/insmalls/webapps/support_llr/ so it is somehow getting the wrong path???

My domain is support.itsmyplanet.org which takes me right to that root folder above. Works for my osticket...

I did try changing the .htaccess file by taking /support/ and making it just /

What else should i try? I did manually go in and make all the setup mods per the instructions, but when I run teh faq/setup it still has the same pathing error.

Thanks,

Jamie

goginet

folowup

Hi,

Here is some more info:

When I am in the admin panel, I see these errors above the words TOP LEVEL.:

------------------

Error The FAQs document upload directory does not exist.

Please create it at: /home/insmalls/webapps/_/home/insmalls/webapps/support_llr/faq/pdf/

Error The FAQ images upload directory does not exist.

Please create it at: /home/insmalls/webapps/_/home/insmalls/webapps/support_llr/faq/images/

------------------

When I click on the add new faq or category, I get broken link error, with this in the URL or browser:

http://support.itsmyplanet.org/home/insmalls/webapps/support_llr/scp/faq_admin.php?fcPath=0&action=new_category(http://support.itsmyplanet.org/home/insmalls/webapps/support_llr/scp/faq_admin.php?fcPath=0&action=new_category)

Once again my URL is support.itsmyplanet.org

and my path to that root ofd the whole osticket install in there is:

home/insmalls/webapps/support_llr/ (taht is where the domain name takes us)

----contents of .htaccess in root:

Options +FollowSymLinks

RewriteEngine On

RewriteBase /

RewriteCond %{REQUEST_FILENAME} !-d

RewriteCond %{REQUEST_FILENAME} !-f

RewriteRule ^(.*)-c(+)-a(+)-p.html$ faq.php?cid=$2&answer=$3&print=true&%{QUERY_STRING}

RewriteRule ^(.*)-c(+)-a(+).html$ faq.php?cid=$2&answer=$3&%{QUERY_STRING}

RewriteRule ^(.*)-c(+)-a(+)-(pg|i)(+)-p.html$ faq.php?cid=$2&answer=$3&$4=$5&print=true&%{QUERY_STRING}

RewriteRule ^(.*)-c(+)-a(+)-(pg|i)(+).html$ faq.php?cid=$2&answer=$3&$4=$5&%{QUERY_STRING}

RewriteRule ^(.*)-c(+)-(pg|i)(+)-p.html$ faq.php?cid=$2&$3=$4&print=true&%{QUERY_STRING}

RewriteRule ^(.*)-c(+)-(pg|i)(+).html$ faq.php?cid=$2&$3=$4&%{QUERY_STRING}

RewriteRule ^(.*)-c(+)-p.html$ faq.php?cid=$2&print=true&%{QUERY_STRING}

RewriteRule ^(.*)-c(+).html$ faq.php?cid=$2&%{QUERY_STRING}

----------

It seems fuddled up on the path???? Thanks,

Jamie

Tim Gall

Hi Jamie,

The .htaccess file will have no affect. Its only used when SEO-Friendly urls is enabled in your admin settings but the path you used is correct (admin setting page).

If you got past the DB setup and did the integration manually you shouldnt need the installer anymore.

It sound like the paths on your server may be amiss.

osFaq uses standard Apache variables (used by PHP) to build the paths.

Primarily: DOCUMENT_ROOT and SCRIPT_FILENAME

To try and get it working you will need to set the DIR_FS_WEB_ROOT path manually in the file:

/faq/include/settings.faq.php

EG:

-------------------------

define('DIR_FS_WEB_ROOT', '/');// absolute web file-system path

You may also need to change the file path for:

define('DIR_FS_DOC', $_SERVER . DIR_WS_DOC);// absolute file-system path

define('DIR_FS_IMAGES', $_SERVER . DIR_WS_IMAGES);// absolute file-system path

-------------------------

If setting the paths manually doesn't help, please open a bug report here: https://sourceforge.net/tracker/?group_id=288518&atid=1221962(https://sourceforge.net/tracker/?group_id=288518&atid=1221962)

This will allow you to keep details about your server config private. You will need to sign up for a free Source-Forge account if you dont already have one.

Also please provide any information you think is relevant to the problem EG: OS, webserver-version, type of subdomain (a dedicated sub-domain or a folder in an existing domain).

I have had a help request about this error before and did a fair bit of research on the subject and quite a bit of testing on a few servers (I was unable to reproduce the problem).

I think its due to a misconfigured subdomain path on your server but never received any confirmation from the previous person who had this issue.

The previous person followed a "How to Forge" tutorial to configure thier server.

Regards,

Tim Gall

goginet

Work - here are some debug findings

Hi Tim,

Thanks for the reply and the osfaq itself. I think I am working OK now. I kept the debug info I created after your reply, in case it would help you. Thanks again,

Jamie

I did some debugging before and after apply some fixes based on your post and what I see in the variables. I added some echo statements to dump values of the $_SERVER and the constants.

Here are my findings - hope it helps you and/or others.

I think I have a fully functional system now - thanks ;-)

Jamie

BEFORE:

phpself=/home/insmalls/webapps/support_llr/faq.php

FSWR=/home/insmalls/webapps/support_llr/

DIR_FS_WEB_ROOT=/home/insmalls/webapps/support_llr/

SCRIPT_FILENAME=/home/insmalls/webapps/support_llr/faq.php

DOCUMENT_ROOT=/home/insmalls/webapps/_

DIR_WS_DOC=/home/insmalls/webapps/support_llr/faq/pdf/

DIR_WS_IMAGES=/home/insmalls/webapps/support_llr/faq/images/

DIR_FS_DOC=/home/insmalls/webapps/_/home/insmalls/webapps/support_llr/faq/pdf/

DIR_FS_IMAGES=/home/insmalls/webapps/_/home/insmalls/webapps/support_llr/faq/images/

FIX#1:

//define('DIR_FS_WEB_ROOT', $FSWR);// absolute web file-system path

define('DIR_FS_WEB_ROOT', '/');// absolute web file-system path

AFTER FIX#1:

phpself=/home/insmalls/webapps/support_llr/faq.php

FSWR=/home/insmalls/webapps/support_llr/

DIR_FS_WEB_ROOT=/

SCRIPT_FILENAME=/home/insmalls/webapps/support_llr/faq.php

DOCUMENT_ROOT=/home/insmalls/webapps/_

DIR_WS_DOC=/faq/pdf/

DIR_WS_IMAGES=/faq/images/

DIR_FS_DOC=/home/insmalls/webapps/_/faq/pdf/

DIR_FS_IMAGES=/home/insmalls/webapps/_/faq/images/

Now in the admin - FAQ , I see the two error warnings in red:

Error The FAQs document upload directory does not exist.

Please create it at: /home/insmalls/webapps/_/faq/pdf/

Error The FAQ images upload directory does not exist.

Please create it at: /home/insmalls/webapps/_/faq/images/

But I am able to add.. edit , and view the FAQs OK.

FIX#2:

// fix #1

//define('DIR_FS_WEB_ROOT', $FSWR);// absolute web file-system path

define('DIR_FS_WEB_ROOT', '/');// absolute web file-system path

//fix #2

//unset($FSWR);//unset temp var

...

// fix#2

//define('DIR_FS_DOC', $_SERVER . DIR_WS_DOC);// absolute file-system path

//define('DIR_FS_IMAGES', $_SERVER . DIR_WS_IMAGES);// absolute file-system path

define('DIR_FS_DOC', $FSWR . 'faq/pdf/');// absolute file-system path

define('DIR_FS_IMAGES', $FSWR . 'faq/images/');// absolute file-system path

unset($FSWR);//unset temp var

AFTER FIX#2:

phpself=/home/insmalls/webapps/support_llr/scp/faq_admin.php

FSWR=/home/insmalls/webapps/support_llr/

DIR_FS_WEB_ROOT=/

SCRIPT_FILENAME=/home/insmalls/webapps/support_llr/scp/faq_admin.php

DOCUMENT_ROOT=/home/insmalls/webapps/_

DIR_WS_DOC=/faq/pdf/

DIR_WS_IMAGES=/faq/images/

DIR_FS_DOC=/home/insmalls/webapps/support_llr//faq/pdf/

DIR_FS_IMAGES=/home/insmalls/webapps/support_llr//faq/images/

PS I also sent a ticket to my hosting service - webfaction - who are really great work with. I asked about that apache variable.

goginet

more info

Hi Tim,

Webfaction (the greatest hosting service in my opinion :-) got back to me. Apparently, there is a reason for this and they have a fix - see link below.

"Our ability to let you mount an application at arbitrary URL paths means we can't set DOCUMENT_ROOT correctly.

Apache won't actually serve files unless DOCUMENT_ROOT is set, so we set to the value you've noticed."

https://help.webfaction.com/165(https://help.webfaction.com/165)

Well, maybe that type of thing was causing other people issues, and this post will help. I know it is hard to program installs for all possible contingencies.

Tim, all seems well on my site, except taht when I upload an image file and paste the code, it is not showing up in the faq. You mention taht we should see an html editor? I just have a big multi-line text box when editing an faq. Do you think that has to do with my issues?

I still am running my fix, and have not done what they say to do above. Images will be nice but not make or break right now.

Thanks,

Jamie

Tim Gall

Hi Jamie,

Thanks for the info. Its very useful and explains exactly what the problem is.

Im busy for the next few weeks with exams but will make sure the next release of osFaq takes the paths into consideration.

This issue shouldn't affect the majority of users but is still a very relevant issue.

The installer for the next release will still attempt to calculate the paths automatically but will also allow them to be edited during the install process.

The problem your having with images (and document uploads) is due to the use of the web-servers document root variable. If I get some spare time before the next release Ill put a patch together to correct this.

The javascript editor calls in the osFaq code are surrounded by a conditional statement that checks for the existence of the /faq/ckeditor folder. If you remove that part of the condition it should allow it to work. You need to edit 2 osFaq files. Instructions are below:

-----------------

FILE 1: In the file /submit_faq.php on line 242 replace

<?php if(WYSIWYG_CLIENT=='true' && is_dir(getenv('DOCUMENT_ROOT') . DIR_FS_WEB_ROOT . 'faq/ckeditor/')){ ?>

with:

<?php if(WYSIWYG_CLIENT=='true'){ ?>

-----------------

FILE 2: In the file /faq/include/staff/faq_admin.inc.php on line 192 replace

if(WYSIWYG_STAFF=='true' && is_dir(getenv('DOCUMENT_ROOT') . DIR_FS_WEB_ROOT . 'faq/ckeditor/')){

with:

if(WYSIWYG_STAFF=='true'){

-----------------

Regards,

Tim Gall

shyraza

right to left language button

hay developers

i wanna ask about

right to left language button for ( Arabic & Hebrew ) in the editor .

i think its very very importance for Arab countries

----------------------------------

Thanks

Diaa Eldin Moustafa

+20144120786

R.I.S.U. stuff

IT manager - karate Trainer

flashEG Administrator

http://www.flashEG.com/diaa(http://www.flashEG.com/diaa)

shyraza

hay all

an tring to edit the lang in that

upload\faq\include\language\english

to arabic but to thing appear just english

plz help

Tim Gall

hay developers
i wanna ask about
right to left language button for ( Arabic & Hebrew ) in the editor .
i think its very very importance for Arab countries

Hi,

This will be included in the next release of osFaq and will also allow for a few other locale settings to be customised.

Once the next release of osTicket is available (the internationalized one) Ill make the osFaq translation files match it in structure so managing translations will be straight forward.

hay all
an tring to edit the lang in that
upload\faq\include\language\english
to arabic but to thing appear just english

The next release will include all osFaq files saved in utf-8 format (some are still in ansii format). This is most likely whats causing the problem you described. Try saving the files in utf-8 format first and see how you go.

Step 1: I would suggest making a copy of the english folder. Rename your copy to 'arabic' and edit the files inside it (dont change thier names though).

Step 2: Make sure the translation files are saved in utf-8 format. I noticed I saved most of them in Ansii format (which will only display english).

Step 3: Goto the page and select 'arabic' from the drop down languages menu.

------------------

Added: Also be sure to log out and then log back in after adding or removing new languages so they display in the languages list. The log out and in bit will reset your current session and cause osFaq to reload the languages list.

------------------

Regards,

Tim Gall

New features for next version

Im currently finishing off an RSS feed generator which will be included in the next release of osFaq. It outputs standard Atom RSS documents. It will replace the existing faq_feed.php file.

The same system will also handle generating sitemap files and allow its elements to be appended to existing sitemaps (presumably generated by your main website on the same domain).

Regards,

Tim Gall

Development Update

Regarding the next release of osFaq (v1.0 RC6).

This post is to keep everyone up to date on the development progress.

First off, RC6 should be the last release candidate (RC) for version 1.0. Then a stable version (ST) will be released. The stable version will include any bug fixes that are reported from RC6 (or that I stumble across).

Whats changed?

The Atom/RSS feeder I mentioned in my previous post is finished.

Im currently finalising the internal settings for the new Sitemapper and will move onto the new installer from there.

The best way to find out whats different in the upcoming release is to check the development notes on the osFaq support site. The notes are updated after the changes have been made and tested.

Development notes: http://osfaq.oz-devworx.com.au/webpage/id/8(http://osfaq.oz-devworx.com.au/webpage/id/8)

Some of the changes are to avoid conflicts with the pending internationalized osTicket release and to make future development of osFaq easier.

At the moment a release date has not been set as it depends on how much time I have free to invest in the development. However Ive covered most of the areas I had planned so it wont be too far away.

Regards,

Tim Gall

AZDSE

Upgrade error in step one

I upgraded ost to the newest version and all went well. I then uploaded the new faq files and checked the integration.

When I run the upgrade script I get the following error in step one:

Warning: require(inc/) : failed to open stream: No such file or directory in /var/www/vhosts/xxxxxxxxx/httpdocs/support/faq/setup/upgrade.php on line 98

Fatal error: require() : Failed opening required 'inc/' (include_path='.:') in /var/www/vhosts/xxxxxxxxxxx/httpdocs/support/faq/setup/upgrade.php on line 98

I am a horrible php hack but it looks to me that it is looking for the folder "inc/" it is in the setup file where is should be.

I have tried to reset permissions and rerun but to no success.

I get a please upgrade because the file type and database do not match when I am in the admin panel.

If anyone could help a newbie out I would appreciate the assistance!

John

Digital Scrapbook Experts LLC

Tim Gall

I upgraded ost to the newest version and all went well. I then uploaded the new faq files and checked the integration.
When I run the upgrade script I get the following error in step one:
...
John
Digital Scrapbook Experts LLC

Hi John,

Ive had a look through the code and think its a bug (an oversight on my part).

Try replacing your /faq/setup/inc/upgrade.php file with the one attached to this post and run the installer again.

I'll also upgrade the current RC5 package with the same fix in a few moments.

Thanks for pointing that out. I may have missed it otherwise.

A new version of osFaq (v1.0.RC6) will be released next month (its in the testing phase now). The previous post from me has a link to the summary of changes.

Regards,

Tim Gall

[upgrade.zip](https://forum.osticket.com/assets/files/migrated/9/78729c9b90a577d5ec3a46ffa99d13c.zip)

AZDSE

Worked great! Thank you for the updated file

Hi John,
Ive had a look through the code and think its a bug (an oversight on my part).
Try replacing your /faq/setup/inc/upgrade.php file with the one attached to this post and run the installer again.
I'll also upgrade the current RC5 package with the same fix in a few moments.
Thanks for pointing that out. I may have missed it otherwise.
A new version of osFaq (v1.0.RC6) will be released next month (its in the testing phase now). The previous post from me has a link to the summary of changes.
Regards,
Tim Gall

Tim,

It worked! Thank you for the update. I really appreciate the work you have done on this mod. You clients have enjoyed having them in the same spot.

John

Tim Gall

Hi John,

Thanks for you're kind comments.

I just thought I should clear up the fact Im not connected to osTicket.

osFaq is merely a contribution I made in the hope it would be useful to others.

To anyone reading this post:

I believe osTicket's next release should be even more beneficial to osTicket clients. Make sure you are subscribed to the osTicket announcements thread to be informed when the next release is made available.

If I have time when the next version of osTicket is released, Ill write a conversion script to assist in migrating any existing osFaq data to the new osTicket system.

What will happen to osFaq?

osFaq will most likely still exist and still be fully usable with the new osTicket system but I don't think it will be needed.

The future of osFaq will be to make it a modular website plugin to suit a range of existing off the shelf systems so people can manage their websites with a single login. It will be ideally suited to developers wishing to provide their clients with an integrated FAQ system.

Regards,

Tim Gall

mewho

remove category count on external faq

Hi tim,

great piece of coding. I have a question: is it possible to remove the category count on the external view (on index.php file). I have translated your mod to hebrew, and everything runs great except for the () around the category count which is all screwy (probably unicode issue). other than that, GREAT JOB

mewho

Tim Gall

Hi tim,
great piece of coding. I have a question: is it possible to remove the category count on the external view (on index.php file). I have translated your mod to hebrew, and everything runs great except for the () around the category count which is all screwy (probably unicode issue). other than that, GREAT JOB
mewho

Hi mewho,

Try changing line 23 (approx) in the file faq/include/functions.php from:echo '<a href="' . format_url(FILE_FAQ, 'cid=' . $ext_cats, 'SSL', $ext_cats) . '">'.$faq_cat.'</a> (' . $ext_cats . ')<br />';

to:echo '<a href="' . format_url(FILE_FAQ, 'cid=' . $ext_cats, 'SSL', $ext_cats) . '">'.$faq_cat.'</a><br />';

You might find the brackets appear in a few other places as well. (main FAQ page and breadcrumb menu). Im guessing either there is no equivalent in hebrew or the () characters have a different utf-8 mapping than ANSI encoding. My guess would be the latter.

I'll try and get a new release out later this month (RC6). It has better support for different languages. Its finished, including the installer/upgrader but needs a bit more testing first. Im a bit tied up with other things for a week or two yet. Its on my list for this month.

Regards,

Tim Gall

« Previous Page Next Page »