Skip to content

Commit

Permalink
Tuning the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ahus1 committed May 4, 2024
1 parent 2ba8a51 commit cb9d586
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 17 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/**
* [source,java]
* --
* ##{at}##SuppressWarnings("UnusedDeclaration")
* /\*...*/
* --
...
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/**
* [source,java]
* --
* ##@##SuppressWarnings("UnusedDeclaration")
* /\*...*/
* --
...
Original file line number Diff line number Diff line change
Expand Up @@ -122,26 +122,14 @@ Instead of writing content like this:

[source,java,subs="quotes"]
----
/\**
* [source,java]
* --
* ##@##SuppressWarnings("UnusedDeclaration")
* /\*...*/
* --
...
include::example$asciidoclet-example-before.java[]
----

Rewrite it like this:

[source,java,subs="quotes"]
----
/\**
* [source,java]
* --
* ##{at}##SuppressWarnings("UnusedDeclaration")
* /\*...*/
* --
...
include::example$asciidoclet-example-after.java[]
----

=== Start path of includes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ The following example uses a dark skin.

If the remote stylesheet is not available due to an unreachable server or a missing stylesheet, the preview will default to the standard stylesheet. Starting with release 0.37.52 of the plugin, the preview shows an error message to notify the user that this happened.

To debug problems with remote stylesheets, use the xref:features/preview/jcef-preview.adoc#devtools[DevTools available for the JCEF preview]. Looking at the console or network tab reveals the full errormessage why a remote stylesheet wasn't loaded.
To debug problems with remote stylesheets, use the xref:features/preview/jcef-preview.adoc#devtools[DevTools available for the JCEF preview]. Looking at the console or network tab reveals the full error message why a remote stylesheet wasn't loaded.

=== Add additional styles or HTML headers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ See xref:./preparing-a-repository.adoc#specifying-required-plugins[Specifying re

In the Terminal tool window, IntelliJ offers a command line interface.

A command like [.linx.macos]#`ls`# [.windows]#`dir`# will show a list of files, but to open one of them the user would need to mark the text, copy it to the clipboard and paste it into a search field for search by file via [.windows.linux]#kbd:[Ctrl+Shift+N]# [.macos]#kbd:[⌘ ⇧ O]#.
A command like [.linux.macos]#`ls`# [.windows]#`dir`# will show a list of files, but to open one of them the user would need to mark the text, copy it to the clipboard and paste it into a search field for search by file via [.windows.linux]#kbd:[Ctrl+Shift+N]# [.macos]#kbd:[⌘ ⇧ O]#.

To avoid the copy-and-paste of file names and to make the filenames clickable, install the plugin https://plugins.jetbrains.com/plugin/7677-awesome-console[Awesome Console].
It will also make URLs in the console clickable.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ image::technical-writing/intellij-table-dimensions.png[]

=== Paste a table from a spreadsheet

As above, but select menu:Paste Table...[] to paste a table which has been copied for example from a spreadsheet programm to the clipboard.
As above, but select menu:Paste Table...[] to paste a table which has been copied, for example, from a spreadsheet program to the clipboard.
For this to work usually menu:tab[] separator works best.
Independent of the format the user selects, it is converted to the standard AsciiDoc table when pasted.

Expand Down

0 comments on commit cb9d586

Please sign in to comment.