Skip to content

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

@drankinatty

Description

@drankinatty

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions