redhat-developer / redhat-developer/vscode-xml

Add support for auto-completion of XML entities

Open
#876 15 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

completion DTD
Dominant language
TypeScript
Stars
328
Forks
101
Avg merge
1d 17h
Merged PRs (30d)
7

Description

In our documentation, we include XML entities via the following markup:

[
  <!ENTITY % entities SYSTEM "generic-entities.ent">
    %entities;
]>

The file generic-entities.ent contains entities, but also include other entity files as well via the following syntax:

<!ENTITY % product-entities     SYSTEM      "product-entities.ent">
%product-entities;

Would it be possible to parse these files for entities and offer their complete and sorted list as an intellisense feature after entering &?

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

Start by examining the XML entity examples in generic-entities.ent and the referenced product-entities.ent files to understand the inclusion syntax. Trace the extension's completion entry point and determine how nested entity files should be parsed and exposed after '&'; done means a complete, sorted entity list is offered through IntelliSense.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.