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.

Sign up for GitHub

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

Add documentation for setting up VSCode #108

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add documentation for setting up VSCode #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccb2be8
Add instructions for using vscode as a gregorio editor
Nokel81 Nov 1, 2023
1e886da
Add configuration-vscode.html
Nokel81 Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions configuration-vscode.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!--
Gregorio web site.
Copyright (C) 2007-2015 The Gregorio project

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-->
<title>Gregorio project website</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="description" content="Free software for typesetting Gregorian chant" lang="en">
<meta name="keywords" content="Gregorian chant, gregorio, gabc, gregoriotex" lang="en">
<meta name="author" content="The Gregorio project">
<link rel="shortcut icon" href="./illus/fav.ico">
<link rel="icon" href="./illus/fav.ico">
<link rel="stylesheet" href="./style.css" type="text/css" title="default">
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
<script type="text/javascript" src="./gregorio-menu.js"></script>
<script>
var context = 'gregorio';
var title = 'Gregorio project website'
</script>
</head>

<body>
<div id="ban">
<img src="./illus/harpedroite.png" title="" class="hd" alt="" />
<a id="haut" name="haut"></a>
<div id="banniere">
</div>
</div>
<script>write_gre_menu();</script>
<div class="flux">
&nbsp;
<!-- IE patch-->
<div class="text">
<!-- End of header -->
<!-- header -->

<h1>Configuring VSCode for Gregorio</h1>

<h3>Automatic score compilation</h3>

<p>A feature of Gregorio version 3.0 and later is the automatic compilation of gabc scores when needed to complete a <span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span> document. For this feature to work, <code>lualatex</code> must be able to launch the <code>gregorio</code> program during compilation.</p>

<p>VSCode can be configured (using the <span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span>-workshop extension) to do this by creating a new tool and a new recipie for compilation.</p>

<p>To create it, open up the JSON user preferences and add the following under "latex-workshop.latex.tools"</p>

<code style="display: block;white-space: pre-wrap;">
{
"name": "lualatex",
"command": "lualatex.exe",
"args": [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understand correctly, this will work only with the Gregorio that comes packaged with TeXLive. Gregorio updates installed outside the TeXLive system requires the --shell-escape option to be active, which I don't see in this configuration.

Now, since we haven't had such an update in several years now, it may not be worth mentioning here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was getting a warning for providing the --shell-escape option which is why I didn't provide it here. I can add a note about this being specifically for the TeXLive version

"%DOC%"
]
},
</code>

<p>And add the following under "latex-workshop.latex.recipes"</p>

<code style="display: block;white-space: pre-wrap;">
{
"name": "LuaLaTex",
"tools": ["lualatex"]
},
</code>

<p>This has been tested using <span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span>Live 2023 and Gregorio 6.0.0.</p>

<p>You should now be able to open up the extension commands and run the "LuaLaTex" recipe on your root file.</p>

<h3>Using VSCode</h3>

<p>Once VSCode is ready, refer to <a href="introduction-editor.html">the introduction page</a> to start using Gregorio!</p>

<!-- footer -->
</div>
<div class="bottom">
</div>
<script>initialize_menu();</script>
</body>
</html>
4 changes: 2 additions & 2 deletions introduction-editor.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@

<h1>Using Gregorio in <span class="tex">T<span class="epsilon">e</span>X</span>Shop</h1>

<p>This page describes how Gregorio is used with a <span class="tex">T<span class="epsilon">e</span>X</span> editor such as <span class="tex">T<span class="epsilon">e</span>X</span>works or <span class="tex">T<span class="epsilon">e</span>X</span>Shop. If you are used to <span class="tex">T<span class="epsilon">e</span>X</span> compilation and know the command line tools, you can refer to the <a href="./introduction-commandline.html">command line introduction</a>.</p>
<p>This page describes how Gregorio is used with a <span class="tex">T<span class="epsilon">e</span>X</span> editor such as <span class="tex">T<span class="epsilon">e</span>X</span>works or <span class="tex">T<span class="epsilon">e</span>X</span>Shop or VSCode. If you are used to <span class="tex">T<span class="epsilon">e</span>X</span> compilation and know the command line tools, you can refer to the <a href="./introduction-commandline.html">command line introduction</a>.</p>


<p>The editor must be correctly configured according to the instructions for <a href="./configuration-texworks.html"><span class="tex">T<span class="epsilon">e</span>X</span>works</a> or <a href="./configuration-texshop.html"><span class="tex">T<span class="epsilon">e</span>X</span>Shop</a>. These instructions can be easily adapted for other tools using <span class="tex">T<span class="epsilon">e</span>X</span>Shop markup, such as the <a href="https://github.com/SublimeText/LaTeXTools"><span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span> Tools for SublimeText</a>.</p>
<p>The editor must be correctly configured according to the instructions for <a href="./configuration-texworks.html"><span class="tex">T<span class="epsilon">e</span>X</span>works</a> or <a href="./configuration-texshop.html"><span class="tex">T<span class="epsilon">e</span>X</span>Shop</a> or <a href="./configuration-vscode.html" >VSCode</a>. These instructions can be easily adapted for other tools using <span class="tex">T<span class="epsilon">e</span>X</span>Shop markup, such as the <a href="https://github.com/SublimeText/LaTeXTools"><span class="latex">L<span class="alpha">a</span>T<span class="epsilon">e</span>X</span> Tools for SublimeText</a>.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the addition of a new editor, this paragraph starts feeling cumbersome to me as it is currently formatted. Perhaps we should consider changing the format to include a bulleted list of the links to configuration instructions?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure


<p>Overall, producing a score involves these steps:</p>

Expand Down