Skip to content

Correct full-width punctuation in PDF shell and JSON examples #105

Description

@dajiaohuang

Problem

Three distributed PDF manuals contain non-ASCII punctuation inside copyable shell/JSON examples. These are present in the current master PDFs and are not merely extraction artifacts: I checked the extracted text and rendered pages.

  • docs/volclava 安装及配置文档.pdf, PDF page 22: one command uses volclava。* (U+3002) where the adjacent working command uses volclava.*. The first glob does not match the shipped volclava.sh / volclava.csh files.
  • The same page separates two chkconfig commands with ; (U+FF1B) for one host, versus ASCII ; for the next host. The full-width character is not a shell command separator.
  • docs/volclava 用户手册.pdf, PDF page 11, section 4.2.6: the JSON example includes "JOBID": "30", and "USER": "root", (U+FF0C / U+FF1A). Copying those tokens does not produce valid JSON.

Verification

The PDFs are byte-identical to the originally audited b361f5642a5cf54250afcc057a1229dd6131e41a versions (git diff reports no changes under docs/ through current 35fd168). Current SHA-256 values:

  • Installation manual: c88075219b423735f782e130cef0557d68353ce65b05cd420f6f58827a892f6e
  • User manual: 33ecab5541dde264975214346c9b9fa895005f5ec82719c007faebb37618283e

Text extraction and rendered-page inspection agree on these characters. No installation or service commands were executed. The JSON token {"USER": "root"} fails a standard JSON parser because the key/value separator must be ASCII :.

Expected result

Regenerate the manuals from their authoritative sources with ASCII punctuation in executable examples, and verify the copied shell tokens and JSON examples after export.

Why this report has no PR

The repository contains the PDFs but no editable source for them. Editing the published PDFs directly would bypass that source and would not provide a durable correction. Please update the source documents and republish them, or make their editable source available.

The existing #83/#84 concern the README's user-guide link, not these contents. None of the currently open PRs changes the PDFs or reports this punctuation defect.

Additional verified occurrence: administrator manual, PDF page 101, the command filtering SUB_TRY_INTERVAL contains a full-width pipe U+FF5C. It is not the ASCII shell pipeline operator. The extracted code point and rendered page were inspected. This example also uses /opt/volclava-1.0/etc/lsb.params; use the actual installation directory when regenerating the command.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions