samuelet / indexmenu

A dokuwiki plugin to show a customizable and sortable index for a namespace.
http://dokuwiki.org/plugin:indexmenu
GNU General Public License v2.0
45 stars 43 forks source link

Site Export: Using indexmenu - A flat TOC in the Namespace to create documentation #314

Open rgleason opened 4 months ago

rgleason commented 4 months ago

We have completely rewritten the OpenCPN User Manual and need to build portable versions in pdf, epub and html using Site Export This is the Basic User Manual we would like to export.

Have there been any changes that would affect the way Site Export used to process Table of Contents? Please see this Site Export Issue

Use TOC file in Namespace - Specified Depth errors -Finished by download failed #131

We are using a flat TOC in the namespace opencpn:manual_user:toc which is created with this code:

{indexmenu>:opencpn:manual_basic#4|msort nsort nojs skipns=/(opencpn:manual_advanced|opencpn:manual_plugins|opencpn:user_community|opencpn:development_community|opencpn:development_manual|opencpn:editor_manual|opencpn:supplementary_hardware|opencpn:supplementary_software|opencpn:user_corner|opencpn:toc|opencpn:toc_manual_basic|opencpn:toc_manual_advanced)/}}

We would like Site Export to simply create the pages listed in the flat Table of Contents and not include any of the other namespaces.

Can you advise if there have been changes to indexmenu that would prevent that? Note: I am not using javascript in the indexmenu.

rgleason commented 4 months ago

After many hours messing around, not knowing what is wrong with siteexport, trying different settings because each setting is not adequately documented for a normal user, I think I just stumbled onto the correct settings after having export results with "Finished but download failed."

I had a search that provided a little insight: “Finished but download failed” message indicates that the export process completed successfully, but the download step encountered an issue. Troubleshoot systematically, and consider using mirrored local servers for testing. If problems persist, file an issue in the bug tracker or seek further assistance from the DokuWiki community

Before I found the right settings in siteexport, my Table of Contents was just totally ignored and the entire website would be processed and fail in this way or fail with a time out. So the steps are:

Define a TOC INSIDE the Book, Manual or Document you want to export, using indexmenu to create that TOC Page. to that definition add the skipns parameter and list each part of the website you do Not want exported. See this example.

From the DWedit of this page https://opencpn.org/wiki/dokuwiki/doku.php?id=opencpn:manual_basic:toc here is an example of the code

{{indexmenu>:opencpn:manual_basic#4|msort nsort nojs skipns=/(opencpn:manual_advanced|opencpn:manual_plugins|opencpn:user_community|opencpn:development_community|opencpn:development_manual|opencpn:editor_manual|opencpn:supplementary_hardware|opencpn:supplementary_software|opencpn:user_corner|opencpn:toc|opencpn:toc_manual_basic|opencpn:toc_manual_advanced)/}}

Go to your indexmenu created TOC (remember it must be INSIDE the book or manual (IE manual_basic namespace) Then as admin select admin from upper right. Then Site Export Then the form should show this way. Set Namespace: opencpn:manual_basic:toc <-- automatic based on the TOC page selected Parent Namespace to export: opencpn:manual_basic:toc <-- automatic based on the TOC page selected Export Type: all sub namespaces Select your Options (all options should be unchecked) Render Engine: xhtml Export Template: dokuwiki

Siteexport-setup

This exports the proper pages, however with a document of 147 pages listed it only gets up to 101 before serve times out.

Request-timeout

This is why I have to get the local dokuwiki server runnning! and it is not saving files. I have checked ACL, checked my ACL privileges and I am an admin superuser for all namespaces and pages.

Also I have identical settings for Siteexport in both local and web configurations.

I remain stumped.

rgleason commented 4 months ago

I was left a nice gift from the download which is sitexport-45.zip. When I open it ( hopefully) I am greeted with this captcha warning and can't use the document, though it looks pretty good!

What should I do, disable the captcha on the public website?

I am trying that, but would like to get the local server working properly.

rgleason commented 4 months ago

Once again, I have come to the conclusion that until I can get dokuwiki running properly locally, I am not going to be able to create the Basic User Manual package for release.

Using siteexport all I get is "Finished but download failed." no matter what is selected, including configuration that run properly in the website server version (but they fail due to timeouts).

Observation: This is a painful process.