diff --git a/en/contribute.html b/en/contribute.html index 35dc5e0..41834d4 100644 --- a/en/contribute.html +++ b/en/contribute.html @@ -150,7 +150,7 @@
Type: nullable string
-This is the shape of the cursor visible when the input buffer contains some string.
+This is the shape of the cursor visible when the input buffer contains some +string.
Type: Style
Style of the cursor.
@@ -188,7 +189,7 @@ yourself when you type recklessly.Type: Style
Style of table header.
Type: List of column configuration
+Type: list of column configuration
Each column config contains format
field (string) and style
field
(Style), that define the content and style of header.
Type: Style
Style of table rows.
Type: List of column configuration
+Type: list of column configuration
Each column config contains format
field (string) and style
field
(Style).
However, unlike table.header.cols, the format
field here
points to a column renderer function.
Type: List of tree configuration
+Type: list of tree configuration
It expects a list of three items. The first component of the tree, then the middle components, and finally the last component of the tree.
Each item requires the format
field which is a string, and the style
field,
@@ -218,7 +219,8 @@ which is the Style object.
Type: nullable string
- +Start a FIFO file when xplr loads. It will track the absolute path of the file +under focus.
Type: string
This is the shape of the prompt for the input buffer.
@@ -290,7 +292,7 @@ which is the Style object.The shape of the separator for the Sort & filter
panel.
Type: Style
-Style for Sort & filter
panel separator.
Style for Sort & filter
panel separator.
Type: nullable string
The content of the default identifier in Sort & filter
panel.
Style for the default identifier in Sort & filter
panel.
Type: Table with filter name as key
-The value contains format field (string) and style field (Style), that define the content and style for the given filter.
+The value contains format field (string) and style field (Style), that define +the content and style for the given filter.
Example:
-xplr.config.general.sort_and_filter_ui.filter_identifiers = {
- AbsolutePathDoesContain = {
- format = "abs=~",
- style = { add_modifiers = { "Bold" }, bg = nil, fg = nil, sub_modifiers = nil },
- }
+xplr.config.general.sort_and_filter_ui.filter_identifiers.AbsolutePathDoesContain = {
+ format = "abs=~",
+ style = { add_modifiers = { "Bold" }, bg = nil, fg = nil, sub_modifiers = nil },
}
sort_and_filter_ui.sort_direction_identifiers.forward.format
Type: nullable string
-The shape of the forward direction indicator for sort identifiers in Sort & filter
panel.
+The shape of the forward direction indicator for sort identifiers in
+Sort & filter
panel.
sort_and_filter_ui.sort_direction_identifiers.forward.style
Type: Style
Style of forward direction indicator.
sort_and_filter_ui.sort_direction_identifiers.reverse.format
Type: nullable string
-The shape of the reverse direction indicator for sort identifiers in Sort & filter
panel.
+The shape of the reverse direction indicator for sort identifiers in
+Sort & filter
panel.
sort_and_filter_ui.sort_direction_identifiers.reverse.style
Type: Style
Style of reverse direction indicator.
sort_and_filter_ui.sorter_identifiers
Type: Table with sorter name as key
-The value contains format field (string) and style field (Style), that define the content and style for the given sorter.
+The value contains format field (string) and style field (Style), that define
+the content and style for the given sorter.
Example:
-sort_and_filter_ui.sorter_identifiers = {
- ByCanonicalAbsolutePath = {
- format = "[c]abs",
- style = { add_modifiers = nil, bg = nil, fg = "Yellow", sub_modifiers = nil },
- }
-}
+sort_and_filter_ui.sorter_identifiers.ByCanonicalAbsolutePath = {
+ format = "[c]abs",
+ style = { add_modifiers = nil, bg = nil, fg = "Yellow", sub_modifiers = nil },
+}
panel_ui.default.borders
-Type: nullable List of strings
+Type: nullable list of strings
Defines where to show borders for the panels.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
Example:
-- Show Left and Right borders only
xplr.config.general.panel_ui.default.borders = {
@@ -352,9 +355,10 @@ xplr.config.general.panel_ui.default.borders = {
Type: Style
Style for panel title.
panel_ui.help_menu.borders
-Type: nullable List of strings
+Type: nullable list of strings
Defines where to show borders for the Help
panel.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
panel_ui.help_menu.style
Type: Style
Style for Help
panel.
@@ -365,9 +369,10 @@ xplr.config.general.panel_ui.default.borders = {
Type: Style
Style for Help
panel title.
panel_ui.input_and_logs.borders
-Type: nullable List of strings
+Type: nullable list of strings
Defines where to show borders for the Input
& Logs
panel.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
panel_ui.input_and_logs.style
Type: Style
Style for Input
& Logs
panel.
@@ -378,9 +383,10 @@ xplr.config.general.panel_ui.default.borders = {
Type: Style
Style for Input
& Logs
panel title.
panel_ui.selection.borders
-Type: nullable List of strings
+Type: nullable list of strings
Defines where to show borders for the Selection
panel.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
panel_ui.selection.style
Type: Style
Style for Selection
panel.
@@ -393,7 +399,8 @@ xplr.config.general.panel_ui.default.borders = {
panel_ui.sort_and_filter.borders
Type: nullable list of strings
Defines where to show borders for the Sort & filter
panel.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
panel_ui.sort_and_filter.style
Type: Style
Style for Sort & filter
panel.
diff --git a/en/node_types.html b/en/node_types.html
index d05e339..fb790f7 100644
--- a/en/node_types.html
+++ b/en/node_types.html
@@ -191,7 +191,7 @@ overwritten by the more specific sub types that are defined.
application = {
-- application/*
["*"] = { meta = { icon = "a" } }
-
+
-- application/pdf
pdf = { meta = { icon = "" } },
diff --git a/en/print.html b/en/print.html
index bf9d2df..6beaf26 100644
--- a/en/print.html
+++ b/en/print.html
@@ -478,7 +478,8 @@ executing commands or performing write operations on the file-system.
yourself when you type recklessly.
cursor.format
Type: nullable string
-This is the shape of the cursor visible when the input buffer contains some string.
+This is the shape of the cursor visible when the input buffer contains some
+string.
cursor.style
Type: Style
Style of the cursor.
@@ -507,7 +508,7 @@ yourself when you type recklessly.
Type: Style
Style of table header.
table.header.cols
-Type: List of column configuration
+Type: list of column configuration
Each column config contains format
field (string) and style
field
(Style), that define the content and style of header.
table.row.height
@@ -517,13 +518,13 @@ yourself when you type recklessly.
Type: Style
Style of table rows.
table.row.cols
-Type: List of column configuration
+Type: list of column configuration
Each column config contains format
field (string) and style
field
(Style).
However, unlike table.header.cols, the format
field here
points to a column renderer function.
table.tree
-Type: List of tree configuration
+Type: list of tree configuration
It expects a list of three items. The first component of the tree, then the
middle components, and finally the last component of the tree.
Each item requires the format
field which is a string, and the style
field,
@@ -537,7 +538,8 @@ which is the Style object.
start_fifo
Type: nullable string
-
+Start a FIFO file when xplr loads. It will track the absolute path of the file
+under focus.
prompt.format
Type: string
This is the shape of the prompt for the input buffer.
@@ -609,7 +611,7 @@ which is the Style object.
The shape of the separator for the Sort & filter
panel.
sort_and_filter_ui.separator.style
Type: Style
-Style for Sort & filter
panel separator.
+Style for Sort & filter
panel separator.
sort_and_filter_ui.default_identifier.format
Type: nullable string
The content of the default identifier in Sort & filter
panel.
@@ -618,42 +620,43 @@ which is the Style object.
Style for the default identifier in Sort & filter
panel.
sort_and_filter_ui.filter_identifiers
Type: Table with filter name as key
-The value contains format field (string) and style field (Style), that define the content and style for the given filter.
+The value contains format field (string) and style field (Style), that define
+the content and style for the given filter.
Example:
-xplr.config.general.sort_and_filter_ui.filter_identifiers = {
- AbsolutePathDoesContain = {
- format = "abs=~",
- style = { add_modifiers = { "Bold" }, bg = nil, fg = nil, sub_modifiers = nil },
- }
+xplr.config.general.sort_and_filter_ui.filter_identifiers.AbsolutePathDoesContain = {
+ format = "abs=~",
+ style = { add_modifiers = { "Bold" }, bg = nil, fg = nil, sub_modifiers = nil },
}
sort_and_filter_ui.sort_direction_identifiers.forward.format
Type: nullable string
-The shape of the forward direction indicator for sort identifiers in Sort & filter
panel.
+The shape of the forward direction indicator for sort identifiers in
+Sort & filter
panel.
sort_and_filter_ui.sort_direction_identifiers.forward.style
Type: Style
Style of forward direction indicator.
sort_and_filter_ui.sort_direction_identifiers.reverse.format
Type: nullable string
-The shape of the reverse direction indicator for sort identifiers in Sort & filter
panel.
+The shape of the reverse direction indicator for sort identifiers in
+Sort & filter
panel.
sort_and_filter_ui.sort_direction_identifiers.reverse.style
Type: Style
Style of reverse direction indicator.
sort_and_filter_ui.sorter_identifiers
Type: Table with sorter name as key
-The value contains format field (string) and style field (Style), that define the content and style for the given sorter.
+The value contains format field (string) and style field (Style), that define
+the content and style for the given sorter.
Example:
-sort_and_filter_ui.sorter_identifiers = {
- ByCanonicalAbsolutePath = {
- format = "[c]abs",
- style = { add_modifiers = nil, bg = nil, fg = "Yellow", sub_modifiers = nil },
- }
-}
+sort_and_filter_ui.sorter_identifiers.ByCanonicalAbsolutePath = {
+ format = "[c]abs",
+ style = { add_modifiers = nil, bg = nil, fg = "Yellow", sub_modifiers = nil },
+}
panel_ui.default.borders
-Type: nullable List of strings
+Type: nullable list of strings
Defines where to show borders for the panels.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
Example:
-- Show Left and Right borders only
xplr.config.general.panel_ui.default.borders = {
@@ -671,9 +674,10 @@ xplr.config.general.panel_ui.default.borders = {
Type: Style
Style for panel title.
panel_ui.help_menu.borders
-Type: nullable List of strings
+Type: nullable list of strings
Defines where to show borders for the Help
panel.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
panel_ui.help_menu.style
Type: Style
Style for Help
panel.
@@ -684,9 +688,10 @@ xplr.config.general.panel_ui.default.borders = {
Type: Style
Style for Help
panel title.
panel_ui.input_and_logs.borders
-Type: nullable List of strings
+Type: nullable list of strings
Defines where to show borders for the Input
& Logs
panel.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
panel_ui.input_and_logs.style
Type: Style
Style for Input
& Logs
panel.
@@ -697,9 +702,10 @@ xplr.config.general.panel_ui.default.borders = {
Type: Style
Style for Input
& Logs
panel title.
panel_ui.selection.borders
-Type: nullable List of strings
+Type: nullable list of strings
Defines where to show borders for the Selection
panel.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
panel_ui.selection.style
Type: Style
Style for Selection
panel.
@@ -712,7 +718,8 @@ xplr.config.general.panel_ui.default.borders = {
panel_ui.sort_and_filter.borders
Type: nullable list of strings
Defines where to show borders for the Sort & filter
panel.
-The possible values are any combination of: "Top", "Bottom", "Left" and "Right".
+The possible values are any combination of: "Top", "Bottom", "Left" and
+"Right".
panel_ui.sort_and_filter.style
Type: Style
Style for Sort & filter
panel.
@@ -2024,7 +2031,7 @@ overwritten by the more specific sub types that are defined.
application = {
-- application/*
["*"] = { meta = { icon = "a" } }
-
+
-- application/pdf
pdf = { meta = { icon = "" } },
@@ -3069,7 +3076,7 @@ to reach out via your preferred way.
Repository maintainers: You can save the users from the pain of managing xplr in their system manually.
Code Reviewers: Teach me your ways of code.
Designers: You can make the logo even more awesome, donate stickers and blog post worthy pictures.
-Bloggers, YouTubers & broadcasters: You can help spread the word.
+Bloggers, YouTubers & broadcasters: You can help spread the word.