Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Numbering on textDocument/documentSymbol #910

Closed
LeoSchae opened this issue Aug 2, 2023 · 0 comments · Fixed by #1251
Closed

Numbering on textDocument/documentSymbol #910

LeoSchae opened this issue Aug 2, 2023 · 0 comments · Fixed by #1251
Labels
enhancement New feature or request

Comments

@LeoSchae
Copy link

LeoSchae commented Aug 2, 2023

I noticed, that when requesting for textDocument/documentSymbol the resulting sections (SymbolKind.Module = 2) only have a number if they are assigned with a label.

A small example would be a document with

\section{Section}\label{sec:outer} % 1 Section
\subsection{Subsection} % 1.1 Subsection

\section{Section'} % 2 Section'
\subsection{Subsection'}\label{sec:inner} % 2.1 Subsection'

The resulting document symbols would be:

1 Section
Subsection
Section'
2.1 Subsection'

So the numbers are correct. But when a section has no label, it is not assigned any number.

Similarly,

\section{Section}\label{sec:outer} % 1 Section
\subsection{Subsection} % 1.1 Subsection
\section{Section'} % 2 Section'
\subsection{Dummy} % 2.1 Dummy
\subsection*{Subsection'}\label{sec:inner} % Subsection'

would result in

1 Section
Subsection
Section'
Dummy
2.1 Subsection'

even though the last subsection does not have a number (it is assigned the number from the previous section, and when Dummy section is removed the number would be 2).
[This is not bad, since we can not use the label anyway, because there is no number.]

I guess my expectation would be for the document symbol to always include the number that appears in the actual document. So the names that are after the % in the code.

I have not looked at the code yet, so I don't know if this is feasible in the current way the document is parsed. I also noticed a similar thing for equations. Equations in the symbol list will be numbered only if they have a label.

@pfoerster pfoerster added the enhancement New feature or request label Aug 14, 2023
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Jan 31, 2025
## [5.21.0] - 2024-10-26

### Added

- Support starred variants in "Go to References" ([#1234](latex-lsp/texlab#1234))
- Add `texlab.latexindent.replacement` setting to allow passing a replacement flag to `latexindent` ([#1222](latex-lsp/texlab#1222))
- Don't require a label to show section numbers for document symbols ([#910](latex-lsp/texlab#910))
- Support navigating to files that are part of the `TEXINPUTS` similar to `BIBINPUTS` ([#1228](latex-lsp/texlab#1228))

### Fixed

- Fix opening `untitled` documents ([#1242](latex-lsp/texlab#1242))
- Handle `\bibitem` when checking for undefined references ([#1171](latex-lsp/texlab#1171))
- Fix false-positive syntax error when using a command inside a `\label` ([#879](latex-lsp/texlab#879))

## [5.20.0] - 2024-10-08

### Added

- Add `texlab.inlayHints.maxLength` setting to allow limiting inlay hint text length ([#1212](latex-lsp/texlab#1212))
- Allow suppressing diagnostics using `% texlab: ignore` magic comments ([#1211](latex-lsp/texlab#1211))

### Fixed

- Fix enabling `texlab.build.useFileList` setting
- Make "Goto Definition" work correctly with starred commands ([#1197](latex-lsp/texlab#1197))

## [5.19.0] - 2024-07-08

### Added

- Add `texlab.build.useFileList` setting to allow controlling whether to use the `.fls` files

### Changed

- Disable using `.fls` files for project detection by default

## [5.18.0] - 2024-07-06

### Added

- Parse `.fls` files to make the project detection more reliable ([#1145](latex-lsp/texlab#1145))

### Fixed

- Fix parsing commands with unicode characters inside BibTeX entries
  ([#1147](latex-lsp/texlab#1147))
- Improve detection of included files when non-ASCII characters are used ([#923](latex-lsp/texlab#923))
- Fix resolving includes starting from files included using `\subimport` ([#1145](latex-lsp/texlab#1145))

## [5.17.0] - 2024-06-23

### Added

- Add label commands from `zref` and `zref-clever` to the list of default label commands
  ([#1140](latex-lsp/texlab#1140))
- Add `texlab.experimental.labelDefinitionPrefixes` and
  `texlab.experimental.labelReferencePrefixes` options ([#1139](latex-lsp/texlab#1139))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants