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

More Detail to Citation Autocomplete #90

Closed
jsinglet opened this issue Apr 6, 2017 · 8 comments
Closed

More Detail to Citation Autocomplete #90

jsinglet opened this issue Apr 6, 2017 · 8 comments

Comments

@jsinglet
Copy link
Contributor

jsinglet commented Apr 6, 2017

Often times the citation key isn't enough to identify a citation. What would be really helpful, rather than the citation key, would be an abbreviated version of the full BibTeX entry. At a minimum:

citation key:
Authors, Year in: Publication
Title

Being able to narrow this with typing would be ideal. If this is not underway I may be able to help with this feature.

@James-Yu
Copy link
Owner

James-Yu commented Apr 6, 2017

Now you can use author names, title, and citation key to filter the autocomplete items. The detailed information is in the blue information icon. I did not quite get what you mean by 'abbreviated version'. Can you please elaborate more?

image

@jsinglet
Copy link
Contributor Author

jsinglet commented Apr 6, 2017

Ah, I just updated and now I see that. However, I still can't see the titles. Like in your screenshot they are cut off (as well as the author information). Is there a way to be able to see more?

@James-Yu
Copy link
Owner

James-Yu commented Apr 6, 2017

The autocomplete window width is fixed in vscode. Alternative suggestions are always welcomed.

@James-Yu James-Yu closed this as completed Apr 6, 2017
@James-Yu James-Yu reopened this Apr 6, 2017
@jsinglet
Copy link
Contributor Author

jsinglet commented Apr 6, 2017

microsoft/vscode#369

Oh my....

@James-Yu
Copy link
Owner

James-Yu commented Apr 6, 2017

Yes it seems the final solution they worked out was the blue icon. Unfortunately it seems that we cannot modify it on the extension side. 😢

@James-Yu James-Yu closed this as completed Apr 6, 2017
@jabooth jabooth reopened this Apr 6, 2017
@jabooth
Copy link
Contributor

jabooth commented Apr 6, 2017

Yeah when I implemented this richer citation intellisense I was a little frustrated at these restrictions.

Current mitigations

1. we have implemented it so that although you might not be able to see all the information, you can still filter based on all the info. By that I mean if you know you are looking for the paper:

Why is it that all research papers have pathologically long titles: a study

and you remember 'pathologically' being in the title, you should be able to do:

\cite{patho

And even if the key is booth2006unrelated the entry should still show up.

2. cmd / ctrl + space triggers the exanded info from the keyboard rather than hitting the blue i.

Other ideas - Citation Browser

In addition to the current intellisense feature, we could have a model window for citations that drops down from the top of VS Code. I was thinking we could call it something like Citation Browser - you could trigger it whenever you want to hunt down a specific citation in a window where we will be able to show more info.

I was thinking we could do this using whatever API we currently use for the Latex Workshop Actions panel.

Other ideas - Rearrange info

We could change what info is given most precedence in the autocomplete window, and let it be cusomized as a user preference. For instance, a user might opt into just showing the title in the intellisense window as that's what they are always looking for. Of course you could always expand the window to see all the info, the filtering would still work based on everything, and the citation key is always the thing that is inserted.

@James-Yu
Copy link
Owner

James-Yu commented Apr 6, 2017

Both ideas are great! Will implement soon (TM)

@James-Yu
Copy link
Owner

James-Yu commented Apr 6, 2017

The new PR should address this problem better. Close this issue for now. Discussion always welcomed!

@James-Yu James-Yu closed this as completed Apr 6, 2017
MrYann added a commit to MrYann/LaTeX-Workshop that referenced this issue Jul 17, 2017
* Report Latex Log errors as diagnostics per file

* Start overhaul

* Fix wrong subtitle for citations

* Add command autocomplete

* Add env and ref autocompletion

* Defaults cite and ref in autocomplete

* Remove obsolete code

* Auto build after save

* Fix undefined active editor problem, add tab view

* Rearrange syntax files

* Update language information

* Add glob as dependency

* Allow switching between tab and viewer

* Add setting items

* Add setting to control debug log display

* Add a status bar indicator

* Add menu items

* New icon

* A clearer icon

* Fix activation language (latex not LaTeX)

* Activate on both 'latex' and 'LaTeX' languages

* Update changelog

* (James-Yu#38) Change language ids to lowercase and hyphenated

* Update changelog

* small improvements to map/forEach in citation provider

* Add basic linter feature

* Tide up root finding logic

* Use time to control linter

* (James-Yu#39) Linting feature

* Add some FAQs to readme

* Display disconnected info in web page title

* Delete temp files

* better solution to make dependent file lookup robust

* remove some semicolons

* Remove try catch in dependent file search

* Revert "Remove try catch in dependent file search"

This reverts commit 194c8f2.

* Remove input argument

* chktex fixes, now asyncronous to compiler errors

* remove unneeded default param from showLinterDiagnostics

* show the chktex code in the diagnosticS

* (James-Yu#46) Save all editors when build

* (James-Yu#48) Use bib entry whitelist to avoid issues

* New icon again hype

* Update changelog

* Disambiguate ChkTeX and LaTeX diagnositics

* (James-Yu#54) Fix inconsistent url in web page

* Initial implementation of real-time ChkTeX

* Add log message for failed pdf viewer refresh

* Update changelog

* pass current file to chktex vs stdin

1. Split the linter command into linter_command_active_file and
linter_command_root_file to be able to customise independenty
2. Parse the length of the reported issue and include this in
diagnostics
3. Reduce default linting interval to 300ms
4. More robustly handle issues around the linter subprocess call

* Add clean and auto-clean features

* minor admin tidying up

* Fix code reporting in diagnostics from chktex

* use alwaysStrict TS flag

* Nips and tucks to the README, including notes on chktex

* Code Actions for many ChkTeX errors

* add space to avoid collision when adding cdots

* Trigger linting on chaging files/initial opening.

* update the chktex defalt args to match atom community

* Only report chktex errors for .tex files

* update README to mention code actions

* (James-Yu#62) Add default commands

* Convert tabs to spaces

* Update changelog and versioning

* Fix undefined intellisense for commands with args

* Remove console logs

* Update changelog

* Fix lint on changing editor ignoring setting

* Refine James-Yu#66 to use existing lintActiveFileIfEnabled func

* Code Action for ChkTeX 12 (interword spacing)

* Update changelog

* Use chokidar to monitor file change

* Add back intellisense refresh delay

* Fix un-watching wrong files

* refinements to file watcher

* add tslint, tighten strictness on ts compiler

* Fix files based on tslint rules

* (James-Yu#73) Further fix tslint errors

* (James-Yu#74) Fix .tex not removed in toolchain

* Update changelog

* Fix a type error

* Typing improvements, bibtex missing key detection

* typing improvements towards no-implicit-any

* (James-Yu#79) Add env intellisense to command autocomplete

* (James-Yu#74) Explain %DOC% and correct `texify` toolchain

* Add a quickpick menu for all commands

* organise autocomplete, refine presentation

* Add an extension root attribute and refractor

* (James-Yu#82) Add uni-math symbols

* Distinguish commands with environment snippets

* Add package requirements to symbols, add script

* Cache default commands/environments

* Async load intellisense data files

* Update readme and changelog

* quick fix for synctex issue

* Update changelog

* Fix type errors

* (James-Yu#80) Use new tab to display raw log, remove tmp

* Refresh log message in real time

* Remove debug logging

* Version bump

* (James-Yu#90) Customize citation intellisense, and browser

* Insert citation key after selection in citation browser

* Hide intellisense details when not citation key as label

* (James-Yu#89) Customizable synctex path

* (James-Yu#92) Add LaTeX Workshop prefix in quick menu

* Add citation browser as a vscode command

* (James-Yu#94) Tweak all-actions command title

* (James-Yu#89) Change some configs, alerts on finding obsolete ones

* (James-Yu#95) Respect both `TEX` and  `TeX` in magic comment

* (James-Yu#96) Better config names with dots

* Synctex use child_process.spawn

* Let toolchain use SPAWN, reformat toolchain config schema

* Update readme, changelog, and version info

* (James-Yu#105) Fix multi-root project toolchain building problem

* (James-Yu#103) Add an `outputDir` config to define the output directory

* Update readme, changelog, and version info

* Update README.md

* (James-Yu#104) Support non-pdflatex toolchain in latexmk

* (James-Yu#110) Dirty hack to solve MikTeX chktex return code 1 problem

* Update changelog

* (James-Yu#114) Clean project also clean files in outdir

* Fix a bug where outputDir config is mis-spelled

* (James-Yu#108) Correctly parse bib entries surrounded by quotes

* Update changelog

* (James-Yu#115) Fix reading wrong outputDir config when creating paths

* Update changelog

* (James-Yu#116) Fix mis-read outputDir config

* Update changelog

* Add default keyboard shortcuts for commands

* Change show latex log to be a command

* (James-Yu#125, James-Yu#126) User configurable citation browser title, intellisense type

* Return promise after providing suggestions

* Match citation browser entry details and descriptions

* Update changelog

* Typo 'auxillary'->'auxiliary'

* (James-Yu#127) Provide context hint in reference intellisense document

* Tweak the range of context in reference intellisense

* Update changelog

* Update readme toolchain

* Fix pdf-viewer oversize horizontally

* Trigger build with .tex file watcher

* Update README.md

Correcting a spelling issue, `ChxTeX` -> `ChkTeX`.

* Update README.md

Fixing a mistake in README: `Quick Open` > `Command Palette`

* Add more debug info on killing process when building

* Update changelog

* Fix James-Yu#144 typo on multline environment

* Update changelog

* Support program magic command

* Add program magic comment related readme contents

* Avoid unnecessary file IO for program magic comment

* Implements James-Yu#141 Add \item to itemize autocompletion

* Update changelog

* Adding new configuration option autoBuildOnTexChange
Revert file extension check change

* Refractor the auto-build settings a bit

* Fix James-Yu#155, remove lstlisting specific highlight rules

* (James-Yu#158) Use theme color to colorize status bar messages

* Fix James-Yu#161. Add auto pairing for $ and `

* Update changelog

* Fix James-Yu#156. Add config to control default viewing params for PDF viewer

* Fix James-Yu#167. Parse chktex stdout if exitcode returns 1 for active file

* Update changelog

* (James-Yu#168) Add new placeholder `%DIR%` in toolchain

* Update deprecated latex-workshop.linter to latex-workshop.chktex.enabled

* Fix James-Yu#169, add new configuration entry to auto-complete globally included `.bib` files

* Change some keybinds to clean up editor context menu

* Created new table of contents view.

* deleted some commented out stuff

* Some small cosmetic updates

* fixed this annoying lint error

* Rename bibtex parser function names

* New bib entry parser partially using regex

* Update changelog

* Update James-Yu#175 to follow tslinter requirements

* Don't activate extension on opening vscode

* Fix James-Yu#132 James-Yu#173. Provide an empty string as quick menu title when no title given in bib

* Change view id to avoid collision with other extensions, update changelog

* Fix James-Yu#178 Add show outline condition, need insider API

* Fix James-Yu#177 Customizable LaTeX outline structure

* Rename `latex-workshop.viewer` configs to `latex-workshop.view`, add `pdf` section to it

* Update changelog

* Fix typo in retrieving outline configuration item

* Fix James-Yu#183 Search citation commands and curly braces to replace citation key

* Fix James-Yu#182 Use `|` as delimiters for outline section tags in same level

* Add some badges to readme

* Add a version update notice

* Add supporting entries in quick menu

* Add suggested issue template

* Update changelog

* Update images in README to HTTPS sources

* Update readme badges

* Fix James-Yu#193 Duplicate quick menu items

* Fix James-Yu#190 Version check using standalone file

* Auto-remove `version` config item

* Update changelog

* Fix James-Yu#196 Citation browser auto-complete remove all chars in brackets

* Fix James-Yu#195 Add lstlisting syntax with plain text support

* Update changelog

* Fix James-Yu#198 Add minted highlight support
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants