projects
/
cli-helper.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
5a77c78
)
docs: add CUSTOM_ID properties to all org-mode sections
master
author
Svjatoslav Agejenko
<svjatoslav@svjatoslav.eu>
Sat, 21 Mar 2026 07:57:18 +0000
(09:57 +0200)
committer
Svjatoslav Agejenko
<svjatoslav@svjatoslav.eu>
Sat, 21 Mar 2026 07:57:18 +0000
(09:57 +0200)
doc/index.org
patch
|
blob
|
history
diff --git
a/doc/index.org
b/doc/index.org
index
ceec8bc
..
fca48f6
100644
(file)
--- a/
doc/index.org
+++ b/
doc/index.org
@@
-13,6
+13,7
@@
* Overview
:PROPERTIES:
* Overview
:PROPERTIES:
+:CUSTOM_ID: overview
:ID: fef7ebc3-0f00-4b82-a926-c0cfdf709762
:END:
:ID: fef7ebc3-0f00-4b82-a926-c0cfdf709762
:END:
@@
-41,6
+42,7
@@
See also: [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][CLI Helper
* User input helper
:PROPERTIES:
* User input helper
:PROPERTIES:
+:CUSTOM_ID: user-input-helper
:ID: 4fca35e4-fdf1-4675-a36f-6206d6fb72cb
:END:
:ID: 4fca35e4-fdf1-4675-a36f-6206d6fb72cb
:END:
@@
-71,6
+73,9
@@
public class Demo {
See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/eu/svjatoslav/commons/cli_helper/CLIHelper.html][Javadoc]] for complete API reference.
** Interactive Menu Selection
See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/eu/svjatoslav/commons/cli_helper/CLIHelper.html][Javadoc]] for complete API reference.
** Interactive Menu Selection
+:PROPERTIES:
+:CUSTOM_ID: interactive-menu-selection
+:END:
The =Menu= class provides an interactive menu for selecting options
from a list using fuzzy matching and cursor keys. It supports
The =Menu= class provides an interactive menu for selecting options
from a list using fuzzy matching and cursor keys. It supports
@@
-110,12
+115,16
@@
In this example, the user is presented with a menu where they can:
* CLI argument helper
:PROPERTIES:
* CLI argument helper
:PROPERTIES:
+:CUSTOM_ID: cli-argument-helper
:ID: eb7d5632-6152-4d37-8e55-1cf4da21c204
:END:
See also: [[https://clig.dev/][Command Line Interface Guidelines]].
** Command and argument
:ID: eb7d5632-6152-4d37-8e55-1cf4da21c204
:END:
See also: [[https://clig.dev/][Command Line Interface Guidelines]].
** Command and argument
+:PROPERTIES:
+:CUSTOM_ID: command-and-argument
+:END:
Every command-line application has a way of receiving input from
users, usually in the form of command-line arguments. A command-line
Every command-line application has a way of receiving input from
users, usually in the form of command-line arguments. A command-line
@@
-175,6
+184,9
@@
For instance, in our example:
- 'vid1.mp4 vid2.mp4 vid3.mp4' are parameters for the *--input* option.
- '5' is a parameter for the *--quality* option.
* Getting the library
- 'vid1.mp4 vid2.mp4 vid3.mp4' are parameters for the *--input* option.
- '5' is a parameter for the *--quality* option.
* Getting the library
+:PROPERTIES:
+:CUSTOM_ID: getting-the-library
+:END:
Follow instructions to embed *cli-helper* library in your project.
Add following snippets to your project *pom.xml* file:
Follow instructions to embed *cli-helper* library in your project.
Add following snippets to your project *pom.xml* file:
@@
-202,6
+214,9
@@
Add following snippets to your project *pom.xml* file:
</repositories>
#+END_SRC
* Getting the source code
</repositories>
#+END_SRC
* Getting the source code
+:PROPERTIES:
+:CUSTOM_ID: getting-the-source-code
+:END:
- This program is free software: released under Creative Commons Zero
(CC0) license
- This program is free software: released under Creative Commons Zero
(CC0) license
@@
-213,6
+228,9
@@
Add following snippets to your project *pom.xml* file:
- [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
** Source code
- [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
** Source code
+:PROPERTIES:
+:CUSTOM_ID: source-code
+:END:
- [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
- [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary][Browse Git repository online]]
- [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
- [[https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary][Browse Git repository online]]
@@
-222,6
+240,9
@@
Add following snippets to your project *pom.xml* file:
- See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]]
* TODO
- See [[https://www3.svjatoslav.eu/projects/cli-helper/apidocs/][JavaDoc]]
* TODO
+:PROPERTIES:
+:CUSTOM_ID: todo
+:END:
List of improvement suggestions:
List of improvement suggestions: