Docbook Editor Configuration - Revision history

Tomodachi94: fix syntax highlighting errors

2024-06-21T18:45:10Z

fix syntax highlighting errors

← Older revision		Revision as of 18:45, 21 June 2024
Line 48:		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="~~commands~~">		<syntaxhighlight lang="console">
	nix-shell -p jetbrains.idea-community --run idea-community		nix-shell -p jetbrains.idea-community --run idea-community
	</syntaxhighlight>		</syntaxhighlight>
Line 61:		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="~~commands~~">		<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>

Samueldr at 05:34, 8 April 2024

2024-04-08T05:34:35Z

← Older revision		Revision as of 05:34, 8 April 2024
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.}}		{{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==

Samueldr: Mark as outdated

2024-04-08T05:34:20Z

Mark as outdated

← Older revision		Revision as of 05:34, 8 April 2024
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.}}

	==For Vim/Neovim==		==For Vim/Neovim==
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">

imported>Samueldr: Makes it obvious that the doc folder isn't special.

2018-04-21T02:24:18Z

Makes it obvious that the doc folder isn't special.

← Older revision		Revision as of 02:24, 21 April 2018
Line 50:		Line 50:
	</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]]

imported>Samueldr: Adds minimalist guide to writing (validating) Docbook using IntelliJ IDEA

2018-04-21T02:21:46Z

Adds minimalist guide to writing (validating) Docbook using IntelliJ IDEA

← Older revision		Revision as of 02:21, 21 April 2018
Line 41:		Line 41:
	])		])
	</syntaxhighlight>		</syntaxhighlight>

			== For IntelliJ IDEA (Community and Ultimate) ==

			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="commands">
			nix-shell -p jetbrains.idea-community --run idea-community
			</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.

			[[File:Docbook-intellij-open.png]]

			=== Adding the docbook schema ===

			At the root of <tt><nixpkgs></tt>, run the following command. It will create a link to docbook, allowing (easier) use of the
			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="commands">
			nix-build -A docbook5 --out-link docbook
			echo $PWD/docbook/share/xml/docbook-5.0/xsd/docbook.xsd
			</syntaxhighlight>

			Open <tt>manual.xml</tt>. After a short while, IntelliJ IDEA will realise it does not know about the schema.

			[[File:Docbook-intellij-schema-error.png]]

			Click on the red light bulb, then <em>Manually setup an external resource</em>.

			[[File:Docbook-intellij-bulb-menu.png]]

			Paste in the full path to the <tt>xsd</tt> file.

			[[File:Docbook-intellij-full-path.png]]

			After this is done, IntelliJ will validate.

			[[File:Docbook-intellij-mistake.png]]

imported>Mic92: simplify neovim configuration

2017-11-02T15:10:32Z

simplify neovim configuration

@@ Line 1: / Line 1: @@
 == For Emacs ==
@@ Line 28: / Line 40: @@
    })
 ])
 </syntaxhighlight>

imported>Disassembler: Adds vim editor for docbook settings

2017-11-01T22:05:28Z

Adds vim editor for docbook settings

@@ Line 28: / Line 28: @@
    })
 ])
 </syntaxhighlight>

imported>Fadenb: whitespace removal

2017-08-27T16:08:28Z

whitespace removal

← Older revision		Revision as of 16:08, 27 August 2017
Line 4:		Line 4:

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	let		let
	pkgs = import <nixpkgs> {};		pkgs = import <nixpkgs> {};
	inherit (pkgs) emacsPackagesNg docbook5 writeText;		inherit (pkgs) emacsPackagesNg docbook5 writeText;

	schemas = writeText "schemas.xml" ''		schemas = writeText "schemas.xml" ''
	<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">		<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
	<documentElement localName="section" typeId="DocBook"/>		<documentElement localName="section" typeId="DocBook"/>
	<documentElement localName="chapter" typeId="DocBook"/>		<documentElement localName="chapter" typeId="DocBook"/>
	<documentElement localName="article" typeId="DocBook"/>		<documentElement localName="article" typeId="DocBook"/>
	<documentElement localName="book" typeId="DocBook"/>		<documentElement localName="book" typeId="DocBook"/>
	<typeId id="DocBook" uri="${docbook5}/xml/rng/docbook/docbookxi.rnc" />		<typeId id="DocBook" uri="${docbook5}/xml/rng/docbook/docbookxi.rnc" />
	</locatingRules>		</locatingRules>
	'';		'';

	in emacsPackagesNg.emacsWithPackages (epkgs: [		in emacsPackagesNg.emacsWithPackages (epkgs: [
	(emacsPackagesNg.trivialBuild {		(emacsPackagesNg.trivialBuild {
	pname = "nix-docbook-mode";		pname = "nix-docbook-mode";
	version = "1970-01-01";		version = "1970-01-01";
	src = writeText "default.el" ''		src = writeText "default.el" ''
	(eval-after-load 'rng-loc		(eval-after-load 'rng-loc
	'(add-to-list 'rng-schema-locating-files "${schemas}"))		'(add-to-list 'rng-schema-locating-files "${schemas}"))
	'';		'';
	})		})
	])		])
	</syntaxhighlight>		</syntaxhighlight>

imported>Fadenb: /* For Emacs */ syntaxhighlight

2017-08-27T09:13:02Z

For Emacs: syntaxhighlight

← Older revision		Revision as of 09:13, 27 August 2017
Line 3:		Line 3:
	The following creates an Emacs with a custom module, which configures nXML for the NixOS / Nixpkgs docbook codebase:		The following creates an Emacs with a custom module, which configures nXML for the NixOS / Nixpkgs docbook codebase:

			<syntaxhighlight lang="nix">
	let		let
	pkgs = import <nixpkgs> {};		pkgs = import <nixpkgs> {};
Line 27:		Line 28:
	})		})
	])		])
			</syntaxhighlight>

imported>Fadenb at 18:26, 21 August 2017

2017-08-21T18:26:33Z

← Older revision		Revision as of 18:26, 21 August 2017
Line 3:		Line 3:
	The following creates an Emacs with a custom module, which configures nXML for the NixOS / Nixpkgs docbook codebase:		The following creates an Emacs with a custom module, which configures nXML for the NixOS / Nixpkgs docbook codebase:

			let
	~~<code>~~		pkgs = import <nixpkgs> {};
	let		inherit (pkgs) emacsPackagesNg docbook5 writeText;
	pkgs = import <nixpkgs> {};
	inherit (pkgs) emacsPackagesNg docbook5 writeText;		schemas = writeText "schemas.xml" ''
			<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
	schemas = writeText "schemas.xml" ''		<documentElement localName="section" typeId="DocBook"/>
	<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">		<documentElement localName="chapter" typeId="DocBook"/>
	<documentElement localName="section" typeId="DocBook"/>		<documentElement localName="article" typeId="DocBook"/>
	<documentElement localName="chapter" typeId="DocBook"/>		<documentElement localName="book" typeId="DocBook"/>
	<documentElement localName="article" typeId="DocBook"/>		<typeId id="DocBook" uri="${docbook5}/xml/rng/docbook/docbookxi.rnc" />
	<documentElement localName="book" typeId="DocBook"/>		</locatingRules>
	<typeId id="DocBook" uri="${docbook5}/xml/rng/docbook/docbookxi.rnc" />		'';
	</locatingRules>
	'';		in emacsPackagesNg.emacsWithPackages (epkgs: [
			(emacsPackagesNg.trivialBuild {
	in emacsPackagesNg.emacsWithPackages (epkgs: [		pname = "nix-docbook-mode";
	(emacsPackagesNg.trivialBuild {		version = "1970-01-01";
	pname = "nix-docbook-mode";		src = writeText "default.el" ''
	version = "1970-01-01";		(eval-after-load 'rng-loc
	src = writeText "default.el" ''		'(add-to-list 'rng-schema-locating-files "${schemas}"))
	(eval-after-load 'rng-loc		'';
	'(add-to-list 'rng-schema-locating-files "${schemas}"))		})
	'';		])
	})
	])
	~~</code>~~