i-net-software / i-net-software/dokuwiki-plugin-siteexport

Export of large documents is unsuccessful online.

Open
#87 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
26
Forks
12
PR merge metrics
No merged PRs in 30d

Description

**NOTE**: __The only way found to get a single continuous and complete document exported is to download the dokuwiki to a local computer and to run the plugin completely locally, due to an excessive number of failures which require "exclusion" of the last page.__

Export of large documents is unsuccessful online, (using PHP 5.6) due to excessive "excluded pages"
However when a **Local dokuwiki** is set up, export of the total document is feasible with it taking approximately 20 minutes for 200 pages. Images land in directories as configured and links work properly.

**NOTE**: This experience used the commits Gerry recently made for Indexmenu, ---not presently in the master as of 1/25/2018.

**Time Settings:**
* PHP max_execution_time 45 minutes
* Configuration: plugin siteexport cachetime | 60 * 60 * 24 |
* Configuration: plugin siteexport max_execution_time | 10000 |

See https://github.com/i-net-software/dokuwiki-plugin-siteexport/issues/85#issue-286177242

If you need to export a large html document, **Do it Locally!!!**
First download the entire dokuwiki and get it running locally.
There is some interruption to the process which causes 55 pages to be "excluded" out of 200 pages. The plugin has to be run to find each of the "exclusions", then the page has to be "excluded" on the configuration page, then the plugin has to be run again to find the next "exclusion" which is between 20-30 minutes each time! Furthermore when you export those excluded pages and try to expand them back into the current place in the html document, all the images are left in a new folder under the namespace, resulting in image folders all over the place. (Note: The pages do work when expanded into the proper location, and all the links do work.) -Whereas when a single continuous download completes successfully, the image files get saved as originally stored and of course the links all work.

We had ample timeout settings for both settings PHP_max_time and the timeout setting in the Configuration so this is not the problem.

Would using a more recent version of PHP (above 5.6) allow export of large html documents, without having "excluded" pages?

The settings used were:
From the [Offline TOC page](https://opencpn.org/wiki/dokuwiki/doku.php?id=opencpn:opencpn_user_manual:toc_offline_user_manual) OR [Main user page](https://opencpn.org/wiki/dokuwiki/doku.php?id=opencpn:opencpn_user_manual)
1. Select from the page's right menu, the icon second from the bottom **Export SiteExport**
2. Set Namespace= _opencpn:opencpn_user_manual:toc_offline_plugins_manual_
3. Parent Namespace to Export= _opencpn:opencpn_user_manual:toc_offline_plugins_manual_
4. Select _Export all subnamespaces_
5. To begin disable the "Export linked pages" option. Once it processes completely, then _Check_ to have **Links** in the document.
6. Export all parameters "do" _Check_
7. Render Engine: _ckedit_
8. Template: _dokuwiki_
9. Everything else is _unchecked_.
10. Just hit **Start** ( without first hitting one of the three "Direct", "Wget" or "Curl")
11. When clicking the start button it should show you that it will export x/y pages.
12. Starts out: _Adding "opencpn:opencpn_user_manual:advanced_features:network_repeater" ( 29 / 385 )_
13. When the plugin completes you will be prompted to download the siteexport.zip file.

**List of Excludes**
required to complete processing the document Online for a successful download
Pages that had to be Excluded
Configuration > SiteExport > Excludes (such as this)
Keep this List of Excludes for later!

options_setting:ships display gps_setup_and_status vector_display_tab gallery_boats opencpn:toc opencpn:user_corner opencpn:supplementary_hardware opencpn:supplementary_software opencpn:developer_manual editors toolbar_buttons toolbar_buttons:tides_and_currents toolbar_buttons:route_mark_manager toolbar_buttons:create_route opencpn_user_manual:toolbar_buttons:ais ais:sart plugins:weather:weatherfax radar_overlay_ais:ais_radar_display charts:nv_charts weather:weather_routing weather:climatology utility_plugins:object_search charts:bsb4_charts utility_plugins:launcher sailing_tools:tactics safety:watchdog navigation:dr_dead_reckoning plugins:safety:sar safety:odraw1.4_pi advanced_features:portable_opencpn_v2 radar_overlay_ais:br24_radar navigation:celestial_navigation included_plugins:grib_weather charts:vfkaps options_setting:connections gps_setup_and_statusvector_display_tab .pdf zip 7z edit_user_manual blank blank.txt cruisersforum github

Leaving this in the Excludes field: .pdf zip 7z edit_user_manual blank blank.txt cruisersforum github

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reproducing the online export using the documented SiteExport settings and the listed exclusion pages, then compare it with the local export behavior. Check whether the 385-page export completes without repeated exclusions and whether images and links remain correctly placed in the downloaded archive.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.