commit dfd457c572f2d07dd646e4b7d207763a8de202df
parent 0ae524e7ced90ad9af9184ca11fb26b3c9e63194
Author: Alex Balgavy <alex@balgavy.eu>
Date: Sat, 27 Aug 2022 13:15:30 +0200
sioyek: add config
Diffstat:
3 files changed, 677 insertions(+), 0 deletions(-)
diff --git a/dot.map b/dot.map
@@ -63,6 +63,11 @@ khal: ~/.config/khal
helix: ~/.config/helix
bitmonero: ~/.config/bitmonero
+# Config: sioyek
+# for macOS:
+sioyek:
+- keys_user.config: ~/Library/Application Support/sioyek/keys_user.config
+- prefs_user.config: ~/Library/Application Support/sioyek/prefs_user.config
# Config: X server (Linux)
xinitrc: ~/.xinitrc
xprofile: ~/.xprofile
diff --git a/sioyek/keys_user.config b/sioyek/keys_user.config
@@ -0,0 +1,407 @@
+
+# you can edit this file to change keybindings lines that start with '#' are comments
+# the syntax is pretty simple. Some examples:
+#command k (command is executed when k is pressed)
+#command <C-k> (command is executed when k is pressed while holding control)
+#command <S-k> (command is executed when k is pressed while holding shift)
+#command <A-k> (command is executed when k is pressed while holding alt)
+#command <S-+> (command is executed when = is pressed while holding shift.
+# Note that <S-=> would not work because of a bug in the command system so
+# when prefixing non-ascii keys with shift, you have to specify the shift
+# modified key in addition to the shift modifier)
+#command <C-S-k> (command is executed when k is pressed while holding control and shift)
+#command gg (command is executed when g is pressed twice)
+#command gt (command is executed when g is pressed and then t is pressed)
+#command g<C-n><S-d>t (command is executed when g is pressed and then n is pressed while holding\
+# control and then d is pressed while holding shift and then t is pressed)
+# you can execute multiple commands using the following syntax:
+#command1;command2;command3 <keybinding>
+
+
+# ---------- NAVIGATION AND ZOOM ----------
+
+# Goto the begining of document. If prefixed with a number, it will go to that page.
+# for example 150gg goes to page 150.
+goto_begining gg
+goto_begining <C-<home>>
+
+# Goto the end of the document
+goto_end <end>
+goto_end <S-g>
+
+# Opens a prompt to enter page number and jump to that page
+goto_page_with_page_number <home>
+
+## Goto left/right/bottom/top side of the page
+#goto_left <unbound>
+#goto_right <unbound>
+#goto_top_of_page <unbound>
+#goto_bottom_of_page <unbound>
+
+# Goto left/right side of the page ignoring white margins
+goto_left_smart <S-^>
+goto_right_smart <S-$>
+
+# Goto the top-right side of page. Usefull for two column documents
+goto_top_of_page;goto_right_smart zz
+
+# Movement (can be prefixed with a number)
+# move_down <down>
+# move_up <up>
+move_left <right>
+move_right <left>
+
+# Goto forward for one page width. (can be prefixed with a number)
+# (note that going forward for one page width is not usually what you want becaue if
+# the page is larger than the screen you will miss some content. What you usually want is screen_down)
+next_page <C-<pagedown>>
+previous_page <C-<pageup>>
+
+# Go down one screen width (can be prefixed with a number which tells how many screen widths should we go down)
+screen_down <space>
+screen_down <C-d>
+screen_down <C-f>
+screen_down <pagedown>
+screen_up <S-space>
+screen_up <backspace>
+screen_up <C-u>
+screen_up <C-b>
+screen_up <pageup>
+
+# Goto the next/prev chapter
+next_chapter gc
+prev_chapter g<S-c>
+
+# Goto previous viewing state and delete the current (and future) state(s).
+# pop_state w
+
+# Goto the previous history point
+prev_state <C-o>
+prev_state <C-<left>>
+
+## Create a new sioyek window
+new_window <C-w>n
+new_window <C-w>v
+new_window <C-w>s
+new_window <C-x>2
+new_window <C-x>3
+
+## Close the current sioyek window
+close_window <C-w>c
+close_window <C-w>q
+close_window <C-x>0
+
+## Search and switch between sioyek windows
+goto_window <A-o>
+goto_window <C-w>j
+
+# If we are not at the end of viewing history, goto the next history point
+next_state <C-i>
+
+# Open table of contents.
+goto_toc t
+
+# Zoom
+zoom_in <S-+>
+zoom_in =
+zoom_out -
+zoom_in <S-j>
+zoom_out <S-k>
+
+## Zoom in/out on the mouse cursor (instead of center of screen)
+# zoom_in_cursor <unbound>
+# zoom_out_cursor <unbound>
+
+# Rotate document
+rotate_clockwise r
+rotate_counterclockwise <S-r>
+
+# Automatically set the zoom level and horizontal offset such that the current page is centered horizontally and
+# it fills the screen width
+fit_to_page_width w
+# Same as fit_to_page_with but ignores page margins
+fit_to_page_width_smart <S-w>
+
+## Same as fit_to_page_width_smart, but instead of filling the screen width, it fills the ratio of screen that is
+## configured in `prefs_user.config` using `fit_to_page_width_ratio` config. See https://github.com/ahrm/sioyek/issues/162#issuecomment-1059738730.
+#fit_to_page_width_ratio <unbound>
+
+# Open a file dialog to select a document.
+open_document o
+# Open an embedded file dialog in sioyek
+# open_document_embedded <C-o>
+# Open an embedded file dialog in sioyek rooted in the directory of current opened file
+open_document_embedded_from_current_path <C-S-o>
+
+# Open a searchable list of previously opened documents.
+open_prev_doc <S-o>
+
+## Opens the last document opened is sioyek. It is usefull when you want to quickly toggle between two documents
+#open_last_document <unbound>
+
+## Keyboard shortcut to enter visual mark mode (instead of right clicking)
+#enter_visual_mark_mode <unbound>
+
+# Command the move the visual mark to the next/previous line
+# these keys only work when a visual mark is set (by right clicking or using `visual_mark_under_cursor` command)
+move_visual_mark_up k
+move_visual_mark_down j
+move_visual_mark_up <up>
+move_visual_mark_down <down>
+
+## lock horizontal scroll, usefull when using laptop touchpads
+# toggle_horizontal_scroll_lock <unbound>
+
+# ---------- SEARCH ----------
+
+# Search the document.
+# example: /something (searches the document for 'something')
+# you can also specify a page range to search:
+# example: /<110,135>something (searches pages 110 to 135 (inclusive) for 'something')
+search /
+
+# Searches the current chapter. This is essentially the same as search but the range prefix is autofilled
+# with the range of the current lowest level subchapter.
+chapter_search c<C-f>
+chapter_search c/
+
+# Goto the next search item. Can be prefixed with a number which is the same as performing the command n times
+# for example if we are on the 10th search result and we input 15n, we go to the 25th search result.
+next_item n
+# Goto the previous search result. Can be prefixed with a number with similar rules as next_item.
+previous_item <S-n>
+
+# ---------- BOOKMARKS ----------
+# Add a bookmark in the current location (opens a text input where you can specify the bookmark text)
+add_bookmark b
+delete_bookmark db
+
+# Open bookmarks menu of the current document.
+goto_bookmark gb
+
+# Open bookmarks menu of all documents.
+goto_bookmark_g g<S-b>
+
+# ---------- HIGHLIGHTS ----------
+# You can select a piece of text and press the `add_highlight` shortcut followed by a symbol (a character from a-z) to highlight
+# the text
+add_highlight h
+# Search in highlights of current document
+goto_highlight gh
+# Search in highlights of all documents
+goto_highlight_g g<S-h>
+# Slick on a highlight and then press the `delete_highlight` shortcut to delete it.
+delete_highlight dh
+
+# Sets the highlight type to be used for other operations (the default highlight type is 'a')
+#set_select_highlight_type
+
+## Same as `add_highlight` but uses the current selected highlight type as the type of highlight
+#add_highlight_with_current_type <unbound>
+
+## Toggle select highlight mode. In select highlight mode, all text selected using mouse will automatically be highlighted
+## with highlight type set using `set_select_highlight_type`
+#toggle_select_highlight <unbound>
+
+# Goto next/previous highlight in current document
+goto_next_highlight gnh
+goto_prev_highlight g<S-n>h
+
+## Goto next/previous highlight of the current selected highlight type
+#goto_next_highlight_of_type <unbound>
+#goto_prev_highlight_of_type <unbound>
+
+# ---------- MARKS ----------
+
+# Mark the current location. After pressing the mark button, you must enter a symbol (a letter from a-z or A-Z).
+# this marks the current location in the file with the entered symbol. Afterwards you will be able to return to
+# the locations of the marks using goto_mark command.
+# example: mm (marks the current location in the file with a mark named 'm')
+set_mark m
+# Goto a previously set mark. After pressing goto_mark you must enter a symbol associated with a previously set mark.
+# example: `m (goes to the location of the mark named m)
+goto_mark `
+
+
+# ---------- PORTALS ----------
+# If we are in default state, goto portal state with the current location in document as the portal source
+# if we are already in the portal state, create the portal with the current location as destination.
+portal p
+
+# Delete the portal with the closest source to current location
+delete_portal dp
+
+# Goto the position of the portal with the closest source to current location
+goto_portal gp
+goto_portal <tab>
+
+# Similar to goto_portal, except when prev_state is called, the destination of the portal is update to be the state
+# on which prev_state is called
+edit_portal <S-p>
+edit_portal <S-<tab>>
+
+# Open/Close the helper window for portals
+toggle_window_configuration <A-p>
+
+## open/close helper window
+#toggle_one_window <unbound>
+
+# ---------- MISC ----------
+
+# Copy selected text
+copy <C-c>
+
+toggle_fullscreen <S-z>
+
+# Toggles whether we highlight pdf links or not
+toggle_highlight <f1>
+
+# open command line
+command ;
+
+# Seach the selected text using one of the search engines defined using search_url_* settings in prefs.config (* can be any letter between 'a' and 'z')
+# see https://sioyek-documentation.readthedocs.io/en/latest/usage.html#external-search
+external_search s
+
+# opens the selected text as a url in the default browser
+# open_selected_url <S-q>
+
+# Toggle dark mode (inverted colors)
+toggle_dark_mode i
+
+## Toggle custom color mode. You can specify the text background color in your `prefs_user.config` file
+## see https://sioyek-documentation.readthedocs.io/en/latest/configuration.html#custom-background-color-and-custom-text-color
+#toggle_custom_color <f8>
+
+# Toggle synctex mode. When in synctex mode, right clicking on a pdf launches the corresponding latex page.
+toggle_synctex <S-s>
+
+## Perform a synctex search under the mouse cursor
+#synctex_under_cursor <unbound>
+
+# While in mouse drag mode, instead of selecting text you can pan the screen using mouse
+toggle_mouse_drag_mode <f6>
+
+# In visual scroll mode, mouse wheel performs `move_visual_mark_up` and `move_visual_mark_down` commands
+toggle_visual_scroll <C-v>
+
+# In visual scroll mode, create an overview to/go to/portal to the definition in highlighted line
+overview_definition l
+goto_definition <C-]>
+portal_to_definition ]
+
+# In presentation mode, we fit the pages to screen and movement keys move entire pages
+toggle_presentation_mode <f5>
+
+## Quit sioyek
+quit q
+
+# Open PDF links using keyboard
+open_link f
+# Select text using keyboard
+keyboard_select v
+# Smart jump using keyboard
+keyboard_smart_jump <S-f>
+## Open overview window using keyboard
+#keyboard_overview <unbound>
+
+## If the preview is not correct, jump to the next preview
+#next_preview <C-n>
+
+## If the preview is not correct, jump to the previous preview
+#previous_preview <C-n>
+
+## Jump to the location of the current overview
+#goto_overview <unbound>
+
+## Create a portal to the location of the current overview
+#portal_to_overview <unbound>
+
+## Center the window on selected text
+#goto_selected_text <unbound>
+
+## Focus the visual mark on the text matching the given string (useful when extensions want to focus on a text)
+#focus_text <unbound>
+
+## Smart jump to the location under mouse cursor
+#smart_jump_under_cursor <unbound>
+## Open overview window to the location under mouse cursor
+#overview_under_cursor <unbound>
+## Set a visual mark under mouse cursor
+#visual_mark_under_cursor <unbound>
+## Close the overview window
+#close_overview <unbound>
+## Exit visual mark mode
+close_visual_mark <esc>
+
+## Import sioyek data from an exported file
+#import <unbound>
+
+## Export sioyek data into a json file
+#export <unbound>
+
+## Execute shell commands. For example:
+## sioyek --new-instance %1
+## in the command %1 expands to the path of the current file and %2 expand to the file name of the current file
+#execute <unbound>
+
+## (deprecated see bottom of the page) Execute a predefined command. these commands are defined in `prefs_user.config` file using the following syntax:
+## --------prefs_user.config-----------
+## execute_command_a some_command %1 %2
+## execute_command_x another_command %2
+## ------------------------------------
+## now in order to execute the second command you can first execute `execute_predefined_command` and then press 'x'
+#execute_predefined_command <unbound>
+
+
+
+## Embed the annotations (highlights and bookmarks) into a new PDF file so they are visible to other PDF readers
+#embed_annotations <unbound>
+
+## Copy the current window configuration to clipboard so they can be used in `prefs_user.config`
+#copy_window_size_config <unbound>
+
+## Opens the default preference file
+#prefs <unbound>
+## Opens the user preference file with highest priority
+#prefs_user <unbound>
+## Opens a list of all user preference files
+#prefs_user_all <unbound>
+
+## Opens the default kwys file
+#keys <unbound>
+## Opens the user keys file with highest priority
+#keys_user <unbound>
+## Opens a list of all user keys files
+#keys_user_all <unbound>
+
+## Enter password for password protected documents
+#enter_password <unbound>
+
+## Toggle fastread mode. this is an experiental feature
+#toggle_fastread <unbound>
+
+## Toggle statusbar display
+#toggle_statusbar <unbound>
+
+## Toggle statusbar display
+#toggle_statusbar <unbound>
+
+## Reload sioyek window
+reload <C-r>
+
+## Set the status string to be displayed in sioyek's statusbar (it is useful for extensions)
+#set_status_string <unbound>
+
+## Clears the status string set by `set_status_string`
+#clear_status_string <unbound>
+
+## Toggles the window titlebar
+#toggle_titlebar <unbound>
+
+## You can bind custom commands defined in `prefs_user.config` using the same syntax as the built-in commands
+## --------prefs_user.config-----------
+## new_command _my_command_name python /path/to/script.py %{file_name} %{paper_name}
+## ------------------------------------
+## now you can bind _my_command_name to a keybind here:
+#_my_command_name <unbound>
diff --git a/sioyek/prefs_user.config b/sioyek/prefs_user.config
@@ -0,0 +1,265 @@
+# (can be 0 or 1) if set, shows a notification on startup if a new version of sioyek is available
+check_for_updates_on_startup 0
+
+# The color with which the screen is cleared before rendering the pdf (this is the background color of the application and not the PDF file)
+background_color 0.97 0.97 0.97
+dark_mode_background_color 0.0 0.0 0.0
+
+# Showing full white text on black background can be irritating for the eye, we can dim the whites a little bit using the contrast option
+dark_mode_contrast 0.8
+
+# Highlight color when text is selected using mouse
+# text_highlight_color 1.0 1.0 0.0
+text_highlight_color 1.0 1.0 0.0
+
+# The color of highlight ruler which is displayed when right click is pressed
+visual_mark_color 0.0 0.0 0.0 0.1
+
+# Highlight color when text is a search match
+search_highlight_color 0.0 1.0 0.0
+
+# Hihglight color for PDF links (note that highlight is off by default
+# and can only be seen by performing a toggle_highlight command. See keys.config for more details)
+link_highlight_color 0.0 0.0 1.0
+
+# Hihglight color for synctex forward search highlights
+synctex_highlight_color 1.0 0.0 1.0
+
+# Urls to use when executing external_search commands
+search_url_s https://scholar.google.com/scholar?q=
+search_url_l http://gen.lib.rus.ec/scimag/?q=
+search_url_g https://www.google.com/search?q=
+
+# Which search url to choose when middle clicking or shift middle clicking on text (the values are the letters of corresponding search_url_* )
+# for example if i set `middle_click_search_engine s`, then we use the url associated with `search_url_s` to handle middle click searches
+middle_click_search_engine s
+shift_middle_click_search_engine l
+
+# The factor by which we increase/decrease zoom when performing zoom_in or zoom_out
+zoom_inc_factor 1.2
+
+# How many inches we move vertically/horizontally when performing move_* commands
+vertical_move_amount 1.0
+horizontal_move_amount 1.0
+
+# When performing screen_down/screen_up we usually don't move a full screen because it causes the user to lose context
+# Here we specify the fraction of the screen width by which we move when performing these commands
+move_screen_ratio 0.5
+
+# If 0, Table of Contents is shown in a hierarchial tree, otherwise it is a flat list (can improve performance for extremely large table of contents)
+flat_toc 0
+
+# If it is 1, when launching the application if we detect multiple monitors, we automatically launch the helper window in second monitor
+should_use_multiple_monitors 0
+
+# If the last opened document is empty, load the tutorial pdf instead
+should_load_tutorial_when_no_other_file 1
+
+# (deprecated, use `should_launch_new_window` instead) If it is 0, then we use the previous instance of sioyek when launching a new file.
+# otherwise a new instance is launched every time we open a new file.
+should_launch_new_instance 1
+
+# If set, we open a new sioyek window when a new file is opened, otherwise we open the file in the previous window
+should_launch_new_window 0
+
+# The command to use when trying to do inverse search into a LaTeX document. Uncomment and provide your own command.
+# %1 expands to the name of the file and %2 expans to the line number.
+#inverse_search_command "C:\path\to\vscode\Code.exe" -r -g %1:%2
+
+# you can specify the exact highlight color for each of 26 different highlight types
+
+# When moving to the next line using visual marker, this setting specifies the distance of the market to the top of the screen in fractions of screen size (center of the screen is zero, top of the screen is one)
+visual_mark_next_page_fraction 0.75
+
+# When moving to the next line using visual marker, this setting determines at which point we move the screen (center of the screen is zero, bottom of the screen is one)
+visual_mark_next_page_threshold 0.25
+
+# If set, we display a checkerboard pattern for unrendered pages (by default we display nothing)
+should_draw_unrendered_pages 0
+
+# If 0, we use the previous renders for overview window which may cause it to be blurry
+# if it is 1, we rerender with the proper resolution for overview window which looks better
+# but may increase power consumption
+rerender_overview 1
+
+## Size of the overview window (1 being as large as the window, valid range is [0, 1])
+# overview_size 0.5 0.5
+
+## Offset of the center of the overview window ((0,0) being the center of the screen and valid raneg is [-1, 1])
+# overview_offset 0.5 0.5
+
+# Use linear texture filtering instead of nearest-neighbor
+# Can improve appearance in very high-resolution screens
+# linear_filter 0
+
+# Use dark mode by default (deprecated, better add `toggle_dark_mode` to `startup_commands` )
+default_dark_mode 0
+
+# If set, we sort the bookmarks by their location instead of their creation time
+sort_bookmarks_by_location 1
+
+## Path to shared.db database file. If not set, we use the default path.
+## you can set this to be a file in a synced folder (e.g. dropbox folder) to automatically sync
+## sioyek across multiple computers
+#shared_database_path /some/path/shared.db
+
+## Name of the font to use for UI text
+#ui_font Some Font Name
+## Size of the UI font
+#font_size 20
+
+## Semicolon-separated list of command to execute upon sioyek startup
+# startup_commands toggle_visual_scroll;toggle_dark_mode
+
+## Background color to use when executing `toggle_custom_color`
+custom_background_color 0.180 0.204 0.251
+## Text color to use when executing `toggle_custom_color`
+custom_text_color 0.847 0.871 0.914
+
+# Normally mouse wheel zooms in on the middle of the screen, but if this is set to 1, we zoom in on the cursor
+wheel_zoom_on_cursor 0
+
+## Color of status bar background
+status_bar_color 1 1 1
+## Color of status bar text
+status_bar_text_color 0.2 0.2 0.2
+## Font size of the status bar text
+status_bar_font_size 14
+
+## The default size of main window when helper window is closed
+#single_main_window_size 800 600
+#single_main_window_move 100 100
+
+## The default size/offset of main/helper window when helper window is opened. You can copy the value of this config using `copy_window_size_config` command
+#main_window_size 800 600
+#main_window_move 100 100
+#helper_window_size 800 600
+#helper_window_move 100 100
+
+## Touchpad/scrollwhell sensitivity
+#touchpad_sensitivity 1.0
+
+## Configure the appearance of page separator
+#page_separator_width 2
+#page_separator_color 0.9 0.9 0.9
+
+# Ratio of page width to use for `fit_to_page_width_ratio` command
+fit_to_page_width_ratio 0.75
+
+# If set, we initially collapse table of content entries
+collapsed_toc 0
+
+# If set, we highlight the current line in visual_scroll_mode by masking above and below the current line
+# if not set, we only mask below the line
+ruler_mode 1
+
+# Additional ruler padding
+ruler_padding 1.0
+ruler_x_padding 5.0
+
+## We use mupdf to determine lines for visual mark. However, we do have a custom algorithm for image documents
+## if `force_custom_line_algorithm` is 1, then we use our custom algorithm instead of mupdf even for documents
+## that have lines.
+#force_custom_line_algorithm 0
+
+# A directory which sioyek watches for new papers. If a new paper added to this directory
+# while we are creating a portal from another document, this new document will automatically
+# be used as the destination of the portal.
+#paper_folder_path /some/path
+
+# Enable some experimental features, might not be stable
+#enable_experimental_features 0
+
+# Automatically create a table of contents for the document if it doesn't already have one
+create_table_of_contents_if_not_exists 1
+
+# Limits the maximum size of created table of contents
+max_created_toc_size 5000
+
+# Warn the user on the command line only when redefining keys inside
+# the same file. When set to 1, sioyek will warn when redefining keys
+# from other files also
+should_warn_about_user_key_override 1
+
+# Use double clicks to select entire words and single clicks for character-based selection
+single_click_selects_words 0
+
+# A prefix to prepend to items in lists (e.g. bookmark lists)
+#item_list_prefix >
+
+## In presentation mode, ignore whitespace when trying to determine the size of a page
+#ignore_whitespace_in_presentation_mode 0
+
+## In list of recent documents, show the entire document path rather than just the name
+#show_doc_path 0
+
+# Show long menu items in multiple lines instead of truncating the string, can reduce performance for
+#very large lists
+multiline_menus 1
+
+# While in present mode, prerender the next page to avoid flickering
+prerender_next_page_presentation 1
+
+## Custom commands to run when clicking or right clicking when modifier keys are pressed
+## the command can be any built-in sioyek command (e.g. overview_under_cursor) or user-defined
+## commands defined using `new_command`
+# shift_click_command some_command
+# control_click_command some_command
+# alt_click_command some_command
+# shift_right_click_command some_command
+# control_right_click_command some_command
+# alt_right_click_command some_command
+
+#Amethyst
+highlight_color_a 0.94 0.64 1.00
+#Blue
+highlight_color_b 0.00 0.46 0.86
+#Caramel
+highlight_color_c 0.60 0.25 0.00
+#Damson
+highlight_color_d 0.30 0.00 0.36
+#Ebony
+highlight_color_e 0.10 0.10 0.10
+#Forest
+highlight_color_f 0.00 0.36 0.19
+#Green
+highlight_color_g 0.17 0.81 0.28
+#Honeydew
+highlight_color_h 1.00 0.80 0.60
+#Iron
+highlight_color_i 0.50 0.50 0.50
+#Jade
+highlight_color_j 0.58 1.00 0.71
+#Khaki
+highlight_color_k 0.56 0.49 0.00
+#Lime
+highlight_color_l 0.62 0.80 0.00
+#Mallow
+highlight_color_m 0.76 0.00 0.53
+#Navy
+highlight_color_n 0.00 0.20 0.50
+#Orpiment
+highlight_color_o 1.00 0.64 0.02
+#Pink
+highlight_color_p 1.00 0.66 0.73
+#Quagmire
+highlight_color_q 0.26 0.40 0.00
+#Red
+highlight_color_r 1.00 0.00 0.06
+#Sky
+highlight_color_s 0.37 0.95 0.95
+#Turquoise
+highlight_color_t 0.00 0.60 0.56
+#Uranium
+highlight_color_u 0.88 1.00 0.40
+#Violet
+highlight_color_v 0.45 0.04 1.00
+#Wine
+highlight_color_w 0.60 0.00 0.00
+#Xanthin
+highlight_color_x 1.00 1.00 0.50
+#Yellow
+highlight_color_y 1.00 1.00 0.00
+#Zinnia
+highlight_color_z 1.00 0.31 0.02
+
