faq

README

@@ -45,7 +45,7 @@ Main features:
       classes
       class methods
 - search in files
-- spell checker plugin (Hunspell library should be installed)
+- spell checker plugin (hunspell library should be installed)
 - terminal emulator plugin (qtermwidget5 library required)
 - built-in colorpicker
 - built-in light and dark themes
@@ -58,7 +58,8 @@ Tested in:
       
 Requirements:
       Qt 5.10+ (5.12.6 is recommended)
-      Hunspell (optional)
+      hunspell library (optional)
+      qtermwidget5 library (optional)
 
 Compiled binary (x86-64) can be found in bin (or bin/arm for ARM) folder.
       

include/helpdialog.h

@@ -18,6 +18,7 @@ public:
     explicit HelpDialog(QWidget *parent = nullptr);
     ~HelpDialog() override;
     void shortcutsContent();
+    void faqContent();
     void aboutContent();
 private:
     Ui::HelpDialog *ui;

include/mainwindow.h

@@ -147,6 +147,7 @@ private slots:
     void on_actionHelpContact_triggered();
     void on_actionHelpDonate_triggered();
     void on_actionHelpZiraCMS_triggered();
+    void on_actionHelpFAQ_triggered();
     void on_actionCompileSass_triggered();
     void on_actionExecuteFile_triggered();
     void focusTreeTriggered();

qrc/help.qrc

@@ -5,5 +5,6 @@
         <file alias="php_manual_files">resources/help/php/files</file>
         <file alias="editor_shortcuts">resources/help/shortcuts</file>
         <file alias="about">resources/help/about</file>
+        <file alias="faq">resources/help/faq</file>
     </qresource>
 </RCC>

qrc/resources/help/about

@@ -1,5 +1,2 @@
 <div><center>Lightweight PHP Editor with syntax check and autocomplete.</center></div>
-<div>&nbsp;</div>
-<div><center>Syntax check performed by php executable.</center></div>
-<div><center>Context help requires php manual.</center></div>
-<div><center>You can download it from php.net (many html files archive).</center></div>
+<div><center>Available for Linux, Android and Raspberry Pi.</center></p>

qrc/resources/help/faq

@@ -0,0 +1,18 @@
+<div><b>Optional dependencies:</b></div>
+<div>
+<ul>
+<li>libhunspell (spell checker plugin)</li>
+<li>libqtermwidget5 (terminal plugin)</li>
+<li>php</li>
+<li>phpcs (php code sniffer)</li>
+<li>git</li>
+<li>sassc (SASS compiler)</li>
+<li>apache2</li>
+<li>mariadb</li>
+<li>bash (start/stop servers)</li>
+</ul>
+</div>
+<div>&nbsp;</div>
+<div>Syntax check performed by php executable.</div>
+<div>Context help (F1) requires php manual.</div>
+<div>You can download it from php.net (many html files archive).</div>

src/helpdialog.cpp

@@ -46,6 +46,18 @@ void HelpDialog::shortcutsContent()
     ui->helpLabel->setText(text);
 }
 
+void HelpDialog::faqContent()
+{
+    QFile f(":/help/faq");
+    f.open(QIODevice::ReadOnly);
+    QTextStream in(&f);
+    QString text = in.readAll();
+    f.close();
+
+    setWindowTitle(tr("FAQ"));
+    ui->helpLabel->setText(text);
+}
+
 void HelpDialog::aboutContent()
 {
     QString text = TPL_LOGO_IMAGE+TPL_APPLICATION_NAME.arg(APPLICATION_NAME);

src/mainwindow.cpp

@@ -1446,6 +1446,13 @@ void MainWindow::on_actionHelpAbout_triggered()
     dialog.exec();
 }
 
+void MainWindow::on_actionHelpFAQ_triggered()
+{
+    HelpDialog dialog(this);
+    dialog.faqContent();
+    dialog.exec();
+}
+
 void MainWindow::on_actionHelpContact_triggered()
 {
     QString url = "mailto:" + AUTHOR_EMAIL_USERNAME + "@" + AUTHOR_EMAIL_DOMAIN;

ui/mainwindow.ui

@@ -203,6 +203,7 @@
     <addaction name="actionHelpZiraCMS"/>
     <addaction name="separator"/>
     <addaction name="actionHelpShortcuts"/>
+    <addaction name="actionHelpFAQ"/>
     <addaction name="actionHelpAbout"/>
    </widget>
    <addaction name="menuFile"/>
@@ -1144,6 +1145,11 @@
     <string>Execute file</string>
    </property>
   </action>
+  <action name="actionHelpFAQ">
+   <property name="text">
+    <string>FAQ</string>
+   </property>
+  </action>
  </widget>
  <layoutdefault spacing="6" margin="11"/>
  <resources>