FAQ
- How can I install the plugin?
- How can I sync editor with internal preview?
- Includes cannot be resolved
- PlantUML not working
- Initial installation slow, updates fast ?
- How can I turn off/on building Asciidoctor preview?
- How can I use installed "native" asciidoctor?
- How can I install "native" asciidoctor?
- Sometimes my includes cannot be resolved
- My *.txt files are associated with Asciidoctor Editor
- My images are not shown inside editor preview
Use the eclipse marketplace client and search for asciidoc or open https://marketplace.eclipse.org/content/asciidoctor-editor
When preference Link editor with internal preview is enabled cursor movement to headlines and anchors inside editor will scroll to corresponding part in preview. This works also from outline view.
When you see in your preview something like:
Unresolved directive in -1808287729_hidden-editorfile_01_deployment.adoc - include::01_01_deployment_server.adoc[] Unresolved directive in -1808287729_hidden-editorfile_01_deployment.adoc - include::01_02_deployment_website.adoc[]
Please press F5 inside editor or the "Refresh" button inside toolbar. This will recalculate cached base path and more. Normally this solves the problem.
This can happen for example when you switch between multiple eclipse projects containing asciidoc files.
This will happen on every machine where plantuml is executed and graphviz is not already installed. PlantUML uses this product to render the images. Its free, see https://graphviz.gitlab.io/license/
So download and install it on your machine: https://www.graphviz.org/download/ (when .msi installer on a windows server you should install graphviz for all users)
More information can be found at https://github.com/de-jcup/eclipse-asciidoctor-editor/issues/47
The initial installation takes a long time, but updates are extreme fast - why?
AsciiDoctor editor is an feature which contains following plugins:
-
asciidoctor-editor-plugin -
asciidoctor-editor-libs(complete jruby, complete asciidoctor (ruby gems) + asciidoctorj (1.5.6)) -
asciidoctor-editor-css(fat css styles for font-awesome and co.)
At installation time all parts of the feature are automatically installed, so you got always all dependencies.
The big dependencies are packaged inside libs and css plugins which are pretty stable. So normally no newer versions are available.
The logic of Asciidoctor Editor is kept inside asciidoctor-editor-plugin. So bugfixes, new features etc. normally lead only to a newer asciidoctor-editor-plugin version which is pretty small
For internal preview the asciidoctor output cannot be turned off, but for external preview auto build can be configured in preferences and is turned off per default as shown in next picture.
But be aware: When turning off the autobuild behaviour for external preview please remember to press F5 (manual rebuild of preview) in editor before pressing F5 inside your external browser view…
More information can be found at issue 143
Please look at Using installed asciidoctor
Please look at https://asciidoctor.org/docs/install-toolchain/ for detailed information
-
install ruby on your OS
-
execute
gem install asciidoctor -
execute
gem install asciidoctor-diagram
The editors base directory resolution does simply search upside until it does not found Asciidoc files any longer. This is expected to be the base directory. If you have empty files inside this will break the resolution and the base directory is no longer calculated correctly.
|
Tip
|
If you have such a problem, you can do following workaround: just add an empty .adoc file or a README.adoc into this folder. |
When somebody has not ONE base dir but multiple ones in ONE Project , only the first one will be resolved correctly by cached base dir.
|
Tip
|
To solve this, just press F5 - or use Refresh button in toolbar. This will reset base dir resolving.
|
For technical details refer BaseDir resolving.
There is a description how to change back file association of "*.txt" to normal text editor and also about the technical reasons why this happens initially after installation of Asciidoctor Editor.
Asciidoctor provides an image directory attribute: imagesdir (see https://docs.asciidoctor.org/asciidoc/latest/macros/images-directory/)
The editor tries to calculate the location of your images directory automatically.
If this makes problems/is not correct, you can set imagesdir editor specific by defining one or more .asciidoctorconfig.adoc files (see
https://github.com/de-jcup/eclipse-asciidoctor-editor/wiki/Asciidoctor-configfiles for the details).
It is also possible to override this globally inside your eclipse preferences - see https://youtu.be/5OhWuJlMScA for a short video how to define global attributes. Here you can also override the imagesdir attribute - e.g. set an absolute path (it is only for the editor).