Bug report/fix: Module "Documentation" (eureka)

This is a place for Module developers to coordinate, collaborate, figure out their problems, and announce their accomplishments.

Moderators: Kyle Skrinak, Moderators

Bug report/fix: Module "Documentation" (eureka)

Postby Project_Manager » Mon Jun 18, 2012 2:08 pm

Evaluating documentation capabilities I failed to get the "documentation" module to run due to a couple of bugs.

Downloaded here: http://web2project-mod.svn.sourceforge.net/viewvc/web2project-mod/documentation/

Version after install: 0.2

Symptoms:

After installation a "Documentation" tab becomes visible. After cklicking it you should get a screen like the enclosed one. In my case the menu bar and the text (MediaWiki) at "Syntax:" are not displayed. If text is written and submitted either nothing happens or a white screen (as reported by other users) appears.
As I am not (yet) common with the WikiWiki-world I did not know what to expect or how to use it.
Because an error is not reported (only in php-error.log an error like some files are missing is reported) I did not recognized this as an bug and just was not using it for a while.

Bugs:

1. w2p-ver. 2.3.1 and 3.x:

- index.php:

Code: Select all
 // require_once ("config.php");
require_once (W2P_BASE_DIR . "/modules/documentation/config.php");


---> module's configuration is not read, because instead of the local file "config.php" the system's config.php file is read! Here the full path has to be set.

- documentation.class.php

Code: Select all
 public function store(CAppUI $AppUI) {   
        global $db, $WIKI_CONFIG;


---> the variable $WIKI_CONFIG becomes unknown in this function!

I solved this by inserting:

Code: Select all
 public function store(CAppUI $AppUI) {   
        global $db, $WIKI_CONFIG;

        require (W2P_BASE_DIR . "/modules/documentation/config.php");


Works, but can be "smarter" solved.

2. w2p-ver. 3.x:

- documentation.class.php

Additionally to the above changes the class "CAppUI" has to be replaced by the new w2p-class "w2p_Core_CAppUI".

Code: Select all
 // public function delete(CAppUI $AppUI) {
    public function delete(w2p_Core_CAppUI  $AppUI) {   


Code: Select all
   // public function store(CAppUI $AppUI) {   
      public function store(w2p_Core_CAppUI  $AppUI) {




Other possible bugs:

During configuration of the module via System Admin 5x different PDF-Converters can be selected. The first three are not selectable, the last 2x (mPDF, HTML2PDF (TCPDF) are selectable and working as I could see.

---> Bug ?

pm.

PS:
@eureka: Nice nick name, especially if the own name is Archimede as I figured it out now, lol...
Attachments
v.3.x_documentation.class.php.txt
(19.84 KiB) Downloaded 10 times
v.2.3.1_documentation.class.php.txt
(19.68 KiB) Downloaded 9 times
index.php.txt
(5.05 KiB) Downloaded 27 times
Clip1.jpg
working documentation entry
(33.06 KiB) Downloaded 6 times
Project_Manager
Evangelist Member
 
Posts: 102
Joined: Fri Nov 18, 2011 3:02 pm
Location: Germany

Postby caseydk » Thu Jun 21, 2012 5:52 am

I've submitted a pull request to Eureka on these tweaks:

https://github.com/eureka2/web2project- ... ion/pull/1
D. Keith Casey, Jr.
Blog: http://CaseySoftware.com/blog
Company: http://Twilio.com/

Core web2project contributor
Maintainer: Microsoft Project Importer and TodoList Module
User avatar
caseydk
Administrator
 
Posts: 3065
Joined: Wed Nov 07, 2007 7:43 pm
Location: Austin, TX

Postby eureka » Thu Jun 21, 2012 5:39 pm

Hi caseyDk, hi Project_Manager,

This request is merged now !
eureka
Evangelist Member
 
Posts: 156
Joined: Sun Feb 22, 2009 10:31 am
Location: France

Postby caseydk » Fri Jul 13, 2012 5:27 am

Excellent. Based on the newest v3.0 stuff, I may submit another pull request soon.

Check out the new Risks module for how the classes have changed:
https://github.com/caseysoftware/web2project-risks

Basically, large chunks of code can simply be deleted with just a bit of rearranging. :)
D. Keith Casey, Jr.
Blog: http://CaseySoftware.com/blog
Company: http://Twilio.com/

Core web2project contributor
Maintainer: Microsoft Project Importer and TodoList Module
User avatar
caseydk
Administrator
 
Posts: 3065
Joined: Wed Nov 07, 2007 7:43 pm
Location: Austin, TX

Postby z2z » Fri Oct 12, 2012 5:36 am

Since 2.4 last stable release , i have been using it but unfortunately most of modules don't work properly :(

I m not able to get mantis, todo and Documentation module project tab to work. Any pointers to solve the issue.
z2z
I want to know more...
 
Posts: 4
Joined: Thu Sep 27, 2012 5:38 am


Return to Module/Add-On Developer

Who is online

Users browsing this forum: No registered users and 0 guests