php / php/web-php

(Documentation) PHP download of Many Html .tar.gz has JS hardcoded to php-chunked-xhtml dir

Open
#1,906 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Status: Needs Triage
Dominant language
PHP
Stars
1.1k
Forks
640
Avg merge
22h 36m
Merged PRs (30d)
16

Description

Affected Page URL

https://www.php.net/distributions/manual/php_manual_en.tar.gz

Describe the bug

This is an oddity. I always download the many html tar-gzipped archive and host locally under phpdoc. When installing the current documentation the archive extracts to ./php-chunked-xhtml/. If you rename that directory, then choosing "Search" leaves a non-function search-box stuck at the bottom of the screen that cannot be closed with the [x] button displayed or Esc as displayed below text-search box.

Restoring the original extraction directory name to ./php-chunked-xhtml/ restores the javascript functionality.

This was surprising as all functionality should be relative to the siteroot, not hardcoded based on the base directory in the archive.

Steps to reproduce
  1. download https://www.php.net/distributions/manual/php_manual_en.tar.gz
  2. extract to a directory accessible on your web server
  3. rename the directory to something convenient to remember, e.g. mv php-chunked-xhtml somedir
  4. access the manual through somedir
  5. click search
  6. now try and use search or try and get rid of the search box and notation at the bottom of the page
Expected behavior

The documentation and javascript shipped with it should work regardless of the name used for the base directory. A functionality should be relative to that base directory regardless of what it is called.

Screenshots

Not Relevant

Additional context

This is a minor documentation issue, but surprising in documentation shipped by PHP. If you need more information, just ask and I'm happy to provide it, but this is pretty simple.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Download and extract https://www.php.net/distributions/manual/php_manual_en.tar.gz, rename the php-chunked-xhtml directory, and inspect the shipped JavaScript used by the manual's Search control. Reproduce the stuck search box after renaming the directory, then verify that search and dismissal work from an arbitrary base-directory name.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, php
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.