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

Anchor/Bookmark Html Links are not made at the anchor.

Open
#79 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

Gamma,

I feel badly about posting, because SiteExport is an important and valuable tool for OpenCPN releases: it creates the Html documentation. The dust has settled now on release of OpenCPN v4.6 and the Help file has been created with manual piecing together, but it worked, referencing an IndexMenu Plugin TOC page.

We've found that Internal Anchor/Bookmark Html Links are not made at the Anchor location. This is probably caused by the fact that Dokuwiki just uses the Headings as automatic anchor links, which is very handy in Dokuwiki, but when we export we need to have those links actually created in order for any Internal or External link with an Anchor/Bookmark to work.

Perhaps there is a setting we have missed?
Thank you for making SiteExport!

An example

------------------

Site Export result:

'AIS Operating Controls'

`

AIS Operating Controls

`

Yet HTML requires at the Anchor/Bookmark location:

`

AIS Operating Controls

`

`Can be left empty`

OR BETTER

`

AIS Operating Controls

`

OR

`

AIS Operating Controls

`

Same problem is occurring to External Page Anchor/Bookmark or "jump to" Links for the same reason.

Example from W3C
https://www.w3schools.com/html/html_links.asp

Create an anchor/bookmark with id attribute at the location (Not done by SiteExport).

`

Chapter 4

`

Then add a link to the anchor/bookmark from within the same page (OK)

`Jump to Chapter 4`

OR
Add a link to the anchor/bookmark from another page

`Jump to Chapter 4`

Differences in **id** and **name** attributes according to WC3
Because of its specification in the HTML DTD, the name attribute may contain character references. Thus, the value Dürst is a valid name attribute value, as is Dürst . The id attribute, on the other hand, may not contain character references.
The "name" attribute allows richer anchor names (with entities).
https://www.w3.org/TR/html4/struct/links.html#h-12.2.1

Contributor guide

No contributing guide indexed for this repository

Research direction

Start in the SiteExport plugin's HTML export path and reproduce the documented example with a DokuWiki heading and internal or external anchor link. Compare the generated heading and link markup with the expected id or name anchor behavior. Done means exported headings provide usable anchors so same-page and cross-page links jump to the intended location.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling, web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.