highlightjs/highlight.js

Explain the difference between php and php-template in their comments

Open

#3,765 opened on Apr 25, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (22,960 stars) (3,497 forks)batch import
buggood first issuehelp welcomeparser

Description

Both php and php-template only have the link to https://www.php.net in their header comments. How does one choose one over another?

And it is unclear how it ended.

I believe that those two languages should have a short comments in headers like

Choose this for any PHP code, with the opening tag or not.

or

Choose this for PHP code with a required opening tag.

(If I got the difference right.)

Contributor guide

Tech stack
javascriptphp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of highlight.js language definitions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Review the referenced discussion in issue #2330 to understand the distinction between `php` and `php template`. Examine the current header comments in the language definition files for both (likely `src/languages/php.js` and `src/languages/php template.js`). Then update those comments with a clear explanation of when to use each. Consider also checking any existing documentation or tests related to these languages.