Manual Module

[uchr]

As fare as i remember there are one more bug, when i tryed to rename a manual something went wrong, it was some dayes ago, so i don't remember what went wrong.
I will look at it, if it is still there. And hope I can fix it.
Maybe tomorrow. .

UCHR

[uchr]

Yes there are one more bug, when I rename the menu title in settings, the directory in pages is updated but the link field in table mod_manual_chapters is not updated, then the menu link can't find the manual page.

uchr

[pcwacht]

Kinda obvious


This manual mod uses the menuname for creating the subdir where it stores the pages
Changing the menuname afterwards breaks this


Options:
1 - do not rename the menuname, kinda obvious
2 - don't let manual mod use menuname (but manual plus sectionid for a name)

option 1 way too obvious but due for errors
for option 2
open up save_chapter.php
From line 72 change to:

Code:

// Get page link URL
$query_page = $database->query("SELECT level,link FROM ".TABLE_PREFIX."pages WHERE page_id = '$page_id'");
$page = $query_page->fetchRow();
$page_level = $page['level'];
$page_link = '/manual'.$section_id;
$chapter_name = $page_link.'/';

This way the dir in wich the pages are stores will get the name manual plus section id.

John


Attached new version (including all previous changes )

[uchr]

  Thanks.
I expect that if there are an option, then I can use it. I think this module where put in the completed modules to early.
What about changing the version number, there are at least 4 different version 2.3 at this moment, and it is a little bit confusing.

uchr.

[ruebenwurzel]

Hello,

yes, you're wright. Added the last version from PCWacht to completed modules with the new version Number 2.4. If now comes any changes we should post here in this thread as a bugfixed file or as a ReleaseCandidate (2.5RC1 and so on). When this RCs are bugfree and ready for production then we will release the next version in completed modules.

ToDoList for a 2.5 version:

• Make the Layout from the frontend editable in the backend
• Add more then one chapter depth

Matthias

[uchr]

No prev-link when reading 1st. sub chapter.
This fix insert a prev-link in the index line.

In view.php change line 69.

old:

Code:

$previous_id = 0;

changed to:

New:

Code:

  if($previous_position == 0 and $parent != 0) {
      $get_previous = $database->query("SELECT * FROM ".TABLE_PREFIX."mod_manual_chapters WHERE chapter_id = '$parent' AND active = '1' LIMIT 1");
      if($get_previous->numRows() > 0) {
        $fetch_previous = $get_previous->fetchRow();
        $previous_title = stripslashes($fetch_previous['title']);
        $previous_link = page_link($fetch_previous['link']);
      }
      $previous_id = $parent;
  }

attached new view.php.txt with fix.

uchr

[virgil]

Hi Matthias

Just because I like the module....
I includet IT and FR languages and
named it 2.4a... just if somebody
would like to have it.

It's up to you to put it under completed modules or not.

Cheers
Virgil

[ruebenwurzel]

thanks uchr and virgil

added your files to the file in completed modules. But from now on i will make new version numbers if something is changing in the modul.

Matthias

[uchr]

As fare as I can see, there are no more "funny" things going on in the manual vers. 2.4.

So the next thing to do is the 2 options Format and more Subchapters you descriped above, am I right?

Uffe

[ruebenwurzel]

Yes,

but this are only wishes from me. As pcwacht wrote seems the part with more depth the more difficult part.

To make the layout editable i think it should be like the news or the bookmark modul, wich shouldn't be to difficult. So that we have at the options not only the header and the footer, we also should have a css part for the layout of the index-lines and the tables and a tables part.

If the depth thing is able, it would be also nice to have in the Options of the manual modul an option where the depth could be choosen (1,2,3 ...).

Matthias

[uchr]

pcwacht and You are right, the Format option is the easy part, I think The header field can be used for that. it would be the easiest way to use the header field.

uffe

[ruebenwurzel]

Hello,

did we also need additional database fields? Isn't it better to have header and footer for input a Header adn footer text seperat and the other layout things in a additional field? Don't know wich is the better way, the fastest to use the header field or the on with more work to have additional fields.

Matthias

[uchr]

Hi Mathias

I don't think a DB field are neded if the heading field are used, One can write so CSS in the heading field, and make CSS classes ind the view.php. Ihave not tryed it but i think it will work.

uffe

[uchr]

Hello

I forgot to answer some of your question. additional database fields is the right way to go, the heading field way. is the easy way.

Uffe

[uchr]

Hi

I am working on the "Layout from the frontend editable in the backend" option described by ruebenwurzel , most of the coding is done, and it will be ready within 4-5 days.

uffe

[kweitzel]

now, that rocks. I really like the module.

One question though, How is the Position ID "calculated"?

I used it quite heavily (obviously for real text) and the links for next chapter and previous chapter don't show correctly, I think, because the Position ID is somehow mixed up (due to earlier Version ...).

It would help, If I am just able to manually correct this issue in the DB.

cheers

Klaus

[uchr]

Hi

You shall look at the chapter_id, parent and position fields.

1st. chapter:
let us say chapter_id=36, parent always 0, position=1 it is the 1st. chapter.

first subchapter:
parent point to chapter_id=36 point to the chapter_id, position=1 it is the 1st. subchapter.

second subchapter:
parent point to chapter_id=36 point to the chapter_id,, position=2 it is the 2nd. subchapter.

2nd. chapter:
chapter_id=(something) parent always 0, position=2 it is the 2nd. chapter.

I hope this is understandable.

uffe

[uchr]

The first one was'nt very good, i try once more!

Hi

You shall look at the chapter_id, parent and position fields.

1st. chapter:
let us say chapter_id=36, parent always 0, position=1 it is the 1st. chapter.

first subchapter:
parent=36 point to the chapter_id of the chapter, position=1 it is the 1st. subchapter.

second subchapter:
parent=36 point to the chapter_id of the chapter, position=2 it is the 2nd. subchapter.

2nd. chapter:
chapter_id=(something) parent always 0, position=2 it is the 2nd. chapter.

This is the right one and I hope it is understandable.

uffe

[kweitzel]

hmm ... I think I've got it ... will let you know, once done ...

cheers

Klaus

[uchr]

New option in Manual admin: "Make the Layout from the frontend editable in the backend"

There are now 3 fields in the settings, Manual Style, Footer and Header

The field Manual Style are used for Manual frontend formatting.

attached: new manual.zip

ruebenwurzel, I have not changed tne version number in the info.php

uffe

[uchr]

Error:
When deleting a manual, the entryes in the DB tables are not deleted.

fix in delete.php.

Old:

Code:

$database->query("DELETE FROM ".TABLE_PREFIX."mod_code WHERE section_id = '$section_id'");

change to:

New:

Code:

$database->query("DELETE FROM ".TABLE_PREFIX."mod_manual_settings WHERE section_id = '$section_id'");
$database->query("DELETE FROM ".TABLE_PREFIX."mod_manual_chapters WHERE section_id = '$section_id'");

attached new manual.zip

uffe

[kweitzel]

wow, you are quick ...

cheers

Klaus

[ruebenwurzel]

@uchr

thanks for your great work.

2.5RC1 Changelog:

• Updated info.php to 2.5RC1
• Updated all copyright notices to include 2006 (Changset 310 from project page)
• Added default value  to all varchar and text fields (Changset 309 from project page)

ToDoList:
As there are additional fields in the database now, there should be an upgrade script in the modul.

Have fun

Matthias

[ruebenwurzel]

Here is 2.5RC2.

2.5RC2 Changelog:

• Updated info.php to 2.5RC2
• Added update script to update from earlier versions to 2.5
• Added "Manual style" text to all language files
• Minor changes in view.php

How to update from earlier versions:
Overwrite all files with the new ones and run once the update_manual.php

Have fun

Matthias

Edit:
Newer version see some post below.

[uchr]

The Manual Module Entries in the Pages directory is not deleted, when a manual is deleted.
The WB only deletes DB entries and files in the pages directory, not directories.

I don't know if there are a reason for it?

This code deletes the directory and files in pages dir. created by the Manual module.
This fix is ONLY for Manual module vers.2.4 and later versions.

Code:

// Check is it Manual module vers. 2.4 or later.
// if it is delete directory and files in Pages dir.
if(file_exists(WB_PATH.'/pages/manual'.$section_id)) {
  rm_full_dir(WB_PATH.'/pages/manual'.$section_id);
}

Can be used with Manual module vers. 2.4 and later versions.

Attached: delete.php.txt with code.

uffe