highlightjs/highlight.js

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

Closed

#3,765 opened on Apr 25, 2023

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)JavaScript (3,497 forks)batch import
buggood first issuehelp welcomeparser

Repository metrics

Stars
 (22,960 stars)
PR merge metrics
 (Avg merge 6m) (2 merged PRs in 30d)

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

Research direction
Review the linked discussion (issue #2330) to understand the difference between 'php' and 'php template' language identifiers. Then update the header comments in the language definition files for both to briefly explain when to use each.
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.
1
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.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90