Docbook Editor Configuration: Difference between revisions
imported>Samueldr Adds minimalist guide to writing (validating) Docbook using IntelliJ IDEA |
Tomodachi94 (talk | contribs) m fix syntax highlighting errors |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{outdated|This page may not see useful updates now that NixOS and Nixpkgs use markdown as the authoring format of the documentation.<br />The content may still be accurate.}} | |||
==For Vim/Neovim== | ==For Vim/Neovim== | ||
<syntaxhighlight lang="nix"> | <syntaxhighlight lang="nix"> | ||
| Line 46: | Line 48: | ||
First off, the feature set for XML and Docbook editing is the same in both versions. Here's a neat one-liner to start the Community edition | First off, the feature set for XML and Docbook editing is the same in both versions. Here's a neat one-liner to start the Community edition | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="console"> | ||
nix-shell -p jetbrains.idea-community --run idea-community | nix-shell -p jetbrains.idea-community --run idea-community | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Then, open the <tt>doc/</tt> folder of the <tt><nixpkgs></tt> project. (Opening a file directly will not allow browsing the directory structure within the IDE. | Then, open the <tt>doc/</tt> or root folder of the <tt><nixpkgs></tt> project. (Opening a file directly will not allow browsing the directory structure within the IDE. | ||
[[File:Docbook-intellij-open.png]] | [[File:Docbook-intellij-open.png]] | ||
| Line 59: | Line 61: | ||
xsd files. The symlink can be updated instead of having to change the full store path in the editor. The second command will print the full path to the docbook xsd. | xsd files. The symlink can be updated instead of having to change the full store path in the editor. The second command will print the full path to the docbook xsd. | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="console"> | ||
nix-build -A docbook5 --out-link docbook | $ nix-build -A docbook5 --out-link docbook | ||
echo $PWD/docbook/share/xml/docbook-5.0/xsd/docbook.xsd | $ echo $PWD/docbook/share/xml/docbook-5.0/xsd/docbook.xsd | ||
</syntaxhighlight> | </syntaxhighlight> | ||