AsciiDoc Tooling: Requirements and Ideas
This page captures requirements and ideas for AsciiDoc tool creators. We believe writers deserve the power of IDEs too. But to achieve that goal, we need to start by answering a very fundamental question:
What do you need it to do?
Only when a tool’s function matches with a writer’s need does it become useful to the writer…and a useful tool. This page tries to capture those needs.
-
Outline view (sections, list of images, list of tables)
-
Navigate on click
-
Drag & drop reordering
-
-
Code folding (visually fold sections and blocks)
-
List of document-wide attributes in a view
-
List of cross references (destinations and references to them) in a view
-
Live preview with sync scroll
-
Auto-complete syntax (e.g., an inline macro)
-
Auto-complete attribute references
-
Refactoring
-
xrefs
-
attribute names
-
file names
-
move selected text to a new file and replace with an include:: to it
-
-
Reformat (Alt+Shift+F)
-
Changes all headings to == style
-
Removes unnecessary blank lines
-
1 sentence per line
-
Each table cell on a separate line, blank line between rows
-
-
Navigation
-
Ctrl+Click (or F3) to jump from xref to destination
-
-
Find usages of current file (Ctrl+Shift+G)
-
Keyboard shortcuts (e.g., bold text)
-
Button for comment/uncomment selected lines
-
Validation
-
Violation report in Problems view
-
Underline inline errors, warnings
-
Errors, warnings and hints in gutter
-
-
Spelling
-
Works offline
-
Ignores labels
-
For more ideas, see http://discuss.asciidoctor.org/Ideas-for-an-Asciidoctor-Editor-IDE-td3542.html.
-
Click to convert between formats (inbound and outbound AsciiDoc)
-
Workbook / workspace that can be cloned as a new project for filling in responses and subsequent revisions