Update Word Processor integration documentation#8
Open
abaevbog wants to merge 3 commits into
Open
Conversation
<!-- include: example --> will be replaced for the _partials/example.md allowing to insert content into multiple pages without copy-pasting
Update documentation for Word, LibreOffice and Google Docs with info on new functionality of the citation dialog and screenshots reflecting the new interface. Citation Dialog and Edit Bibliography sections are inserted as partials so that there is a single source of truth shared by multiple pages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update the support pages for Word, LibreOffice, and Google Docs integrations to include new functionality of the citation dialog, remove mentions of "Classic Dialog", and use screenshots with the new UI. Moved all sections related to the citation dialog under the Cite section - previously, some sections like "Citations with Multiple Cited Items" were placed under the "Customizing Citations" header, which seemed inconsistent to me.
There were some differences with descriptions of citation functionality between those 3 pages. I didn't want to copy-paste the sections about the citation dialog to ensure such drift doesn't happen again in the future. My fear was that when something changes, one page would get updated while other ones - not. So I added a small tweak to
hooks.pyto parse strings like<!-- include: integration/citation_dialog_keyboard_commands.md -->and insert in their place the .md file from_partials/folder. That way, there is a singlecitation_dialog_keyboard_commands.mdsection that is added into multiple pages, so there is one place to update instead of 3.