();
private int restIndex = 0;
boolean shouldHideNotification = false;
private int MAX_SPEECH_SIZE = 4000;
private String getPlayerStateString(int state){
if (state == Player.STATE_READY) return "Ready";
if (state == Player.STATE_ENDED) return "Ended";
if (state == Player.STATE_IDLE) return "Idle";
if (state == Player.STATE_BUFFERING) return "Buffering";
return "Unknown";
}
@Override
public void onCreate() {
super.onCreate();
CustomPlayer player = new CustomPlayer(getMainLooper());
player.prepare();
mediaSession = new MediaSession.Builder(this, player)
.setId("sioyek")
.setCallback(new MediaSession.Callback() {
@Override
public int onPlayerCommandRequest(MediaSession session, MediaSession.ControllerInfo controller, int playerCommand) {
boolean isFromSioyek = controller.getPackageName().equals(getApplicationContext().getPackageName());
if (playerCommand == SimpleBasePlayer.COMMAND_PLAY_PAUSE){
if (tts.isSpeaking()){
pauseLocation = tempPauseLocation + pauseLocation;
tts.stop();
player.updatePlaybackState(Player.STATE_ENDED, true);
publishExternalTtsState(getPlayerStateString(Player.STATE_ENDED));
}
else{
String currentText = spokenText;
if (restIndex > 0){
currentText = restOfDocument.get(restIndex - 1);
}
tts.speak(currentText.substring(pauseLocation), TextToSpeech.QUEUE_FLUSH, null, "hi");
player.updatePlaybackState(Player.STATE_READY, true);
publishExternalTtsState(getPlayerStateString(Player.STATE_READY));
}
}
return MediaSession.Callback.super.onPlayerCommandRequest(session, controller, playerCommand);
}
})
.build();
tts = new TextToSpeech(this, new TextToSpeech.OnInitListener() {
@Override
public void onInit(int status) {
if (status == TextToSpeech.SUCCESS) {
MAX_SPEECH_SIZE = tts.getMaxSpeechInputLength();
ttsInitialized = true;
tts.setOnUtteranceProgressListener(new UtteranceProgressListener() {
@Override
public void onStart(String s) {
publishTtsState("Speaking");
}
@Override
public void onDone(String s) {
publishTtsState("Ready");
if (restIndex < restOfDocument.size()){
tts.speak(restOfDocument.get(restIndex), TextToSpeech.QUEUE_FLUSH, null, "hi");
pauseLocation = 0;
tempPauseLocation = 0;
restIndex++;
}
// if (restOfDocument.length() > 0){
// tts.speak(restOfDocument, TextToSpeech.QUEUE_FLUSH, null, "hi");
// restOfDocument = "";
// }
}
@Override
public void onRangeStart(String utteranceId, int start, int end, int frame){
tempPauseLocation = start;
sendMessage(pauseLocation + start, pauseLocation + end);
}
@Override
public void onError(String s) {
publishTtsState("Error");
}
});
}
}
});
}
@Override
public int onStartCommand (Intent intent, int flags, int startId) {
if (intent.getStringExtra("text") != null){
spokenText = intent.getStringExtra("text");
pauseLocation = 0;
tempPauseLocation = 0;
}
if (intent.hasExtra("rate")){
float rate = intent.getFloatExtra("rate", 1.0f);
tts.setSpeechRate(rate);
}
if (intent.hasExtra("resume")){
handleResumeState();
}
if (intent.hasExtra("stop")){
}
if (intent.hasExtra("rest")){
String rest = intent.getStringExtra("rest");
setRestText(rest);
}
return super.onStartCommand(intent, flags, startId);
}
@Override
public void onTaskRemoved(@Nullable Intent rootIntent) {
Player player = mediaSession.getPlayer();
if (!player.getPlayWhenReady() || player.getMediaItemCount() == 0) {
stopForeground(true);
stopSelf();
}
}
@Override
public void onDestroy() {
mediaSession.release();
mediaSession = null;
super.onDestroy();
}
@Override
public MediaSession onGetSession(MediaSession.ControllerInfo controllerInfo){
SessionCommands commands = new SessionCommands.Builder().add(new SessionCommand("set_text", new Bundle())).build();
Player.Commands playerCommands = new Player.Commands.Builder().addAll(
Player.COMMAND_PLAY_PAUSE,
Player.COMMAND_GET_CURRENT_MEDIA_ITEM,
Player.COMMAND_GET_MEDIA_ITEMS_METADATA).build();
mediaSession.setAvailableCommands(controllerInfo, commands, playerCommands);
return mediaSession;
}
private void sendMessage(int begin, int end){
Intent intent = new Intent("sioyek_tts");
intent.putExtra("begin", begin);
intent.putExtra("end", end);
LocalBroadcastManager.getInstance(this).sendBroadcast(intent);
}
private void publishTtsState(String state){
Intent intent = new Intent("sioyek_tts_state");
intent.putExtra("state", state);
LocalBroadcastManager.getInstance(this).sendBroadcast(intent);
}
private void publishExternalTtsState(String state){
Intent intent = new Intent("sioyek_external_tts_state");
intent.putExtra("state", state);
LocalBroadcastManager.getInstance(this).sendBroadcast(intent);
}
int findFirstSpaceBefore(String text, int index){
for (int i = index; i > 0; i--){
if (text.charAt(i) == ' '){
return i;
}
}
return 0;
}
void setRestText(String rest){
while (rest.length() > MAX_SPEECH_SIZE){
int index = findFirstSpaceBefore(rest, MAX_SPEECH_SIZE);
restOfDocument.add(rest.substring(0, index));
rest = rest.substring(index);
}
if (rest.length() > 0){
restOfDocument.add(rest);
}
restIndex = 0;
}
void handleResumeState(){
boolean isOnRest = restIndex > 0;
boolean isPlaying = tts.isSpeaking();
int offset = tempPauseLocation + pauseLocation;
if (isOnRest){
for (int i = 0; i < restIndex-1; i++){
offset += restOfDocument.get(i).length();
}
}
tts.stop();
pauseLocation = 0;
tempPauseLocation = 0;
restOfDocument.clear();
restIndex = 0;
SioyekActivity.onResumeState(isPlaying, isOnRest, offset);
}
}
================================================
FILE: build_and_release.sh
================================================
#!/usr/bin/env bash
set -e
if [ -z ${MAKE_PARALLEL+x} ]; then export MAKE_PARALLEL=$(nproc); else echo "MAKE_PARALLEL defined"; fi
echo "MAKE_PARALLEL set to $MAKE_PARALLEL"
# download linuxdeployqt if not exists
if [[ ! -f linuxdeployqt-continuous-x86_64.AppImage ]]; then
wget -q https://github.com/probonopd/linuxdeployqt/releases/download/continuous/linuxdeployqt-continuous-x86_64.AppImage
chmod +x linuxdeployqt-continuous-x86_64.AppImage
fi
cd mupdf
make USE_SYSTEM_HARFBUZZ=yes -j$MAKE_PARALLEL
cd ..
if [ -z ${QMAKE+x} ]; then
QMAKE=qmake
fi
if [[ $1 == console ]]; then
$QMAKE "CONFIG+=linux_app_image console" pdf_viewer_build_config.pro
else
$QMAKE "CONFIG+=linux_app_image" pdf_viewer_build_config.pro
fi
rm -rf sioyek-release 2> /dev/null
make install INSTALL_ROOT=sioyek-release -j$MAKE_PARALLEL
cp pdf_viewer/prefs.config sioyek-release/usr/bin/prefs.config
cp pdf_viewer/prefs_user.config sioyek-release/usr/share/prefs_user.config
cp pdf_viewer/keys.config sioyek-release/usr/bin/keys.config
cp pdf_viewer/keys_user.config sioyek-release/usr/share/keys_user.config
cp -r pdf_viewer/shaders sioyek-release/usr/bin/shaders
cp tutorial.pdf sioyek-release/usr/bin/tutorial.pdf
./linuxdeployqt-continuous-x86_64.AppImage ./sioyek-release/usr/share/applications/sioyek.desktop -qmldir=./pdf_viewer/touchui -appimage
# ./linuxdeployqt-continuous-x86_64.AppImage ./sioyek-release/usr/share/applications/sioyek.desktop -appimage
mv Sioyek-* Sioyek-x86_64.AppImage
zip sioyek-release-linux.zip Sioyek-x86_64.AppImage
================================================
FILE: build_linux.sh
================================================
#!/usr/bin/env bash
set -e
# Compile mupdf
cd mupdf
make USE_SYSTEM_HARFBUZZ=yes -j$(nproc)
cd ..
# set QMAKE if not already defined
if [ -z "$QMAKE" ];
then
if [ -f "/usr/bin/qmake-qt6" ];
then
QMAKE="/usr/bin/qmake-qt6"
elif [ -f "/usr/bin/qmake" ];
then
QMAKE="/usr/bin/qmake"
else
QMAKE="qmake"
fi
fi
$QMAKE "CONFIG+=linux_app_image" pdf_viewer_build_config.pro
make -j$(nproc)
# Copy files in build/ subdirectory
rm -rf build 2> /dev/null
mkdir build
mv sioyek build/sioyek
cp pdf_viewer/prefs.config build/prefs.config
cp pdf_viewer/prefs_user.config build/prefs_user.config
cp pdf_viewer/keys.config build/keys.config
cp pdf_viewer/keys_user.config build/keys_user.config
cp -r pdf_viewer/shaders build/shaders
cp tutorial.pdf build/tutorial.pdf
================================================
FILE: build_mac.sh
================================================
#!/usr/bin/env bash
set -e
# prerequisite: brew install qt@5 freeglut mesa harfbuzz
#sys_glut_clfags=`pkg-config --cflags glut gl`
#sys_glut_libs=`pkg-config --libs glut gl`
#sys_harfbuzz_clfags=`pkg-config --cflags harfbuzz`
#sys_harfbuzz_libs=`pkg-config --libs harfbuzz`
if [ -z ${MAKE_PARALLEL+x} ]; then export MAKE_PARALLEL=1; else echo "MAKE_PARALLEL defined"; fi
echo "MAKE_PARALLEL set to $MAKE_PARALLEL"
cd mupdf
#make USE_SYSTEM_HARFBUZZ=yes USE_SYSTEM_GLUT=yes SYS_GLUT_CFLAGS="${sys_glut_clfags}" SYS_GLUT_LIBS="${sys_glut_libs}" SYS_HARFBUZZ_CFLAGS="${sys_harfbuzz_clfags}" SYS_HARFBUZZ_LIBS="${sys_harfbuzz_libs}" -j 4
make HAVE_GLUT=no -j$MAKE_PARALLEL
cd ..
sed -Ei '' "s/QMAKE_MACOSX_DEPLOYMENT_TARGET.=.[0-9]+/QMAKE_MACOSX_DEPLOYMENT_TARGET = $(sw_vers -productVersion | cut -d. -f1)/" pdf_viewer_build_config.pro
if [[ $1 == portable ]]; then
qmake pdf_viewer_build_config.pro
else
qmake "CONFIG+=non_portable" pdf_viewer_build_config.pro
fi
make -j$MAKE_PARALLEL
rm -rf build 2> /dev/null
mkdir build
mv sioyek.app build/
cp -r pdf_viewer/shaders build/sioyek.app/Contents/MacOS/shaders
cp pdf_viewer/prefs.config build/sioyek.app/Contents/MacOS/prefs.config
cp pdf_viewer/prefs_user.config build/sioyek.app/Contents/MacOS/prefs_user.config
cp pdf_viewer/keys.config build/sioyek.app/Contents/MacOS/keys.config
cp pdf_viewer/keys_user.config build/sioyek.app/Contents/MacOS/keys_user.config
cp tutorial.pdf build/sioyek.app/Contents/MacOS/tutorial.pdf
# Capture the current PATH
CURRENT_PATH=$(echo $PATH)
# Define the path to the Info.plist file inside the app bundle
INFO_PLIST="build/sioyek.app/Contents/Info.plist"
# Add LSEnvironment key with PATH to Info.plist
/usr/libexec/PlistBuddy -c "Add :LSEnvironment dict" "$INFO_PLIST" || echo "LSEnvironment already exists"
/usr/libexec/PlistBuddy -c "Add :LSEnvironment:PATH string $CURRENT_PATH" "$INFO_PLIST" || /usr/libexec/PlistBuddy -c "Set :LSEnvironment:PATH $CURRENT_PATH" "$INFO_PLIST"
# Hack is required to avoid race condition in macos in CI
# See https://github.com/actions/runner-images/issues/7522
if [[ -n "$GITHUB_ACTIONS" ]]; then
echo killing...; sudo pkill -9 XProtect >/dev/null || true;
echo waiting...; while pgrep XProtect; do sleep 3; done;
fi
sleep 5
# mac deploys with qml currently don't work due to a qt bug
# macdeployqt build/sioyek.app -qmldir=./pdf_viewer/touchui -dmg
macdeployqt build/sioyek.app -dmg
codesign --force --deep --sign - build/sioyek.app
zip -r sioyek-release-mac.zip build/sioyek.dmg
================================================
FILE: build_windows.bat
================================================
cd mupdf\platform\win32\
msbuild -maxcpucount mupdf.sln /m /property:Configuration=Debug /property:MultiProcessorCompilation=true
msbuild -maxcpucount mupdf.sln /m /property:Configuration=Release /property:MultiProcessorCompilation=true
cd ..\..\..
cd zlib
nmake -f win32/makefile.msc
cd ..
qmake -tp vc "DEFINES+=NON_PORTABLE" "CONFIG+=release" pdf_viewer_build_config.pro
msbuild -maxcpucount sioyek.vcxproj /m /property:Configuration=Release
rm -r sioyek-release-windows 2> NUL
mkdir sioyek-release-windows
cp release\sioyek.exe sioyek-release-windows\sioyek.exe
cp pdf_viewer\keys.config sioyek-release-windows\keys.config
cp pdf_viewer\prefs.config sioyek-release-windows\prefs.config
cp -r pdf_viewer\shaders sioyek-release-windows\shaders
cp tutorial.pdf sioyek-release-windows\tutorial.pdf
windeployqt --qmldir ./pdf_viewer/touchui --release sioyek-release-windows\sioyek.exe
REM windeployqt sioyek-release-windows\sioyek.exe
cp windows_runtime\vcruntime140_1.dll sioyek-release-windows\vcruntime140_1.dll
cp windows_runtime\libssl-1_1-x64.dll sioyek-release-windows\libssl-1_1-x64.dll
cp windows_runtime\libcrypto-1_1-x64.dll sioyek-release-windows\libcrypto-1_1-x64.dll
if %1 == portable (
cp pdf_viewer\keys_user.config sioyek-release-windows\keys_user.config
cp pdf_viewer\prefs_user.config sioyek-release-windows\prefs_user.config
7z a sioyek-release-windows-portable.zip sioyek-release-windows
) else (
7z a sioyek-release-windows.zip sioyek-release-windows
)
================================================
FILE: data/command_docs.json
================================================
{"goto_begining": "\n
goto_begining
\n
Go to the beginning of the document. If prefixed with a number, it will go to that page number.
\n
\n
goto_end
\n
Go to the end of the document. If prefixed with a number, it will go to that page number.
\n
\n
goto_definition
\n
While the visual ruler is highlighting a line, executing goto_definition will jump to the location of reference in that line. For example,\nexecuting this command while a line containing "Figure 2.1" is highlighted will jump to the location of the figure in the document.
\n
\n
overview_definition
\n
Similar to goto_definition, but instead of jumping to the location of the reference, it will show a small overview of the reference in the\noverview window.
\n
\n
portal_to_definition
\n
Similar to goto_definition, but instead of jumping to the location of the reference, it will create a portal from current location to the\nlocation of the definition.
\n
\n
next_item
\n
While a search is in progress, this command will jump to the next search result.
\n
\n
previous_item
\n
While a search is in progress, this command will jump to the previous search result.
\n
\n
set_mark
\n
Mark the location with the symbol entered following the set_mark command.
\n
\n
goto_mark
\n
Go to the mark previously set using set_mark.
\n
\n
goto_page_with_page_number
\n
Go to the page number corresponding to entered text.
\n
\n
search
\n
Search for a text in document.
\n
\n
regex_search
\n
Search for a regular expression in the document.
\n
\n
move_down, move_up, move_left, move_right
\n
Move the document.
\n
\n
move_down, move_up, move_left, move_right
\n
Move the document.
\n
\n
move_down, move_up, move_left, move_right
\n
Move the document.
\n
\n
move_down, move_up, move_left, move_right
\n
Move the document.
\n
\n
zoom_in and zoom_out
\n
Change the zoom level.
\n
\n
zoom_in and zoom_out
\n
Change the zoom level.
\n
\n
fit_to_page_width and fit_to_page_height
\n
Fit the current page to window width/height.
\n
\n
fit_to_page_width and fit_to_page_height
\n
Fit the current page to window width/height.
\n
\n
fit_to_page_width_smart and fit_to_page_height_smart
\n
Fit the current page (ignoring white margins) to window width/height.
\n
\n
fit_to_page_width_smart and fit_to_page_height_smart
\n
Fit the current page (ignoring white margins) to window width/height.
\n
\n
next_page and previous_page
\n
Navigate to the next/previous page.
\n
\n
next_page and previous_page
\n
Navigate to the next/previous page.
\n
\n
open_document
\n
Open the file browser to open a document.
\n
\n
add_bookmark
\n
Add a bookmark to the current location at the document with the entered text.
\n
\n
add_highlight
\n
Add the selected text as a highlight with the type of following symbol.
\n
\n
goto_toc
\n
Open the table of contents.
\n
\n
goto_bookmark
\n
Open bookmark list of current document.
\n
\n
goto_highlight
\n
Open highlight list of current document.
\n
\n
goto_bookmark_g
\n
Open bookmark list of all documents.
\n
\n
goto_highlight_g
\n
Open highlight list of all documents.
\n
\n
portal
\n
Set the current location as the portal source. If a portal source is already set, then use the current\nlocation as the portal destination and create the portal.
\n
\n
next_state, prev_state
\n
Go forward/backward in history.
\n
\n
next_state, prev_state
\n
Go forward/backward in history.
\n
\n
delete_bookmark
\n
Delete the closest bookmark to the current location.
\n
\n
delete_highlight
\n
Delete the last highlight clicked on.
\n
\n
delete_portal
\n
Delete the closest portal to the current location.
\n
\n
goto_portal
\n
Go to the destination of the closest portal source to the current document location.
\n
\n
edit_portal
\n
Jump to the destination of the closest portal. All the edits you do to the location/zoom is applied to the portal\nwhen you go back by executing prev_state.
\n
\n
open_prev_doc
\n
Open a list of all opened document using sioyek.
\n
\n
open_document_embedded
\n
Open an embedded file browser in sioyek.
\n
\n
open_document_embedded_from_current_path
\n
Open an embedded file browser in sioyek. Initially, we are in the directory of current document.
\n
\n
copy
\n
Copy the selected text into clipboard.
\n
\n
toggle_fullscreen
\n
Toggle fullscreen mode.
\n
\n
toggle_one_window
\n
Open/close the helper window.
\n
\n
toggle_highlight
\n
Toggle whether we highlight PDF links.
\n
\n
toggle_synctex
\n
Toggle synctex mode. In synctex mode, right clicking on a PDF file opens the corresponding location in the latex file\nusing the configured text editor.
\n
\n
command
\n
Open a list of all sioyek commands.
\n
\n
external_search
\n
Search the selected text in the extenal search engine corresponding to the following symbol.
\n
\n
open_selected_url
\n
Open the selected URL in a browser.
\n
\n
screen_up and screen_down
\n
Move the screen up/down.
\n
\n
screen_up and screen_down
\n
Move the screen up/down.
\n
\n
next_chapter and prev_chapter
\n
Go to the next/previous chapter in the current document.
\n
\n
next_chapter and prev_chapter
\n
Go to the next/previous chapter in the current document.
\n
\n
toggle_dark_mode
\n
Switch between light/dark colorschemes.
\n
\n
toggle_presentation_mode
\n
Toggle presentation mode. In presentation mode we only show one page at a time and the current page\nfills the entire window.
\n
\n
toggle_mouse_drag_mode
\n
Toggle mouse drag mode. In mouse drag mode, clicking and dragging using mouse moves the document (instead of selecting text).
\n
\n
close_window
\n
Close the current window.
\n
\n
quit and q
\n
Quit sioyek (closes all windows).
\n
\n
quit and q
\n
Quit sioyek (closes all windows).
\n
\n
open_link
\n
Open the PDF links using keyboard. Each link will be shown with a label and the link corresponding to the entered label text will be opened.
\n
\n
keyboard_select
\n
Select text using keyboard. Each word in the document will be shown with a label. You should enter the labels corresponding to the\nbeginning and end of the selection (separated by a space).
\n
\n
keyboard_smart_jump and keyboard_overview
\n
Perform a smartjump (or open an overview) using keyboard. Each word in the document will be shown with a label and we will smart jump to the location of the\nreference corresponding to the entered label.
\n
\n
keyboard_smart_jump and keyboard_overview
\n
Perform a smartjump (or open an overview) using keyboard. Each word in the document will be shown with a label and we will smart jump to the location of the\nreference corresponding to the entered label.
\n
\n
keys and prefs
\n
Open the keys.config / prefs.config file.
\n
\n
keys and prefs
\n
Open the keys.config / prefs.config file.
\n
\n
keys_user and prefs_user
\n
Open the keys_user.config / prefs_user.config file.
\n
\n
keys_user and prefs_user
\n
Open the keys_user.config / prefs_user.config file.
\n
\n
export and import
\n
Export/import sioyek data to/from a json file.
\n
\n
export and import
\n
Export/import sioyek data to/from a json file.
\n
\n
enter_visual_mark_mode
\n
Place a visual mark at the center of screen.
\n
\n
move_visual_mark_down and move_visual_mark_up
\n
Move the visual mark up and down which highlights the previous/next line.
\n
\n
move_visual_mark_down and move_visual_mark_up
\n
Move the visual mark up and down which highlights the previous/next line.
\n
\n
toggle_custom_color
\n
Toggle custom color mode. In this mode, we change the text/background color of the document to the colors specified in prefs_user.config.
\n
\n
execute
\n
Execute the entered text as a shell command.
\n
\n
execute_predefined_command
\n
Execute the predefined command (in prefs_user.config) corresponding to the following symbol.
\n
\n
embed_annotations
\n
Export a new version of the current document with all sioyek annotations embedded so that they are visible in other software.
\n
\n
copy_window_size_config
\n
Copy the current window size configuration (useful when you want to set the configs in prefs_user.config).
\n
\n
toggle_select_highlight
\n
Toggle select highlight mode. In this mode, just selecting the text automatically highlights it.
\n
\n
set_select_highlight_type
\n
Set the highlight type used in select highlight mode.
\n
\n
open_last_document
\n
Open the previous document.
\n
\n
toggle_window_configuration
\n
Toggle between one window/two window configuration settings.
\n
\n
prefs_user_all and keys_user_all
\n
Show a list of all prefs_user.config / keys_user.config files discovered by sioyek.
\n
\n
prefs_user_all and keys_user_all
\n
Show a list of all prefs_user.config / keys_user.config files discovered by sioyek.
\n
\n
fit_to_page_width_ratio
\n
Similar to fit_to_page_width but instead of fitting to the entire screen width, we fit to a ratio configured in\nprefs_user.config.
\n
\n
smart_jump_under_cursor and overview_under_cursor
\n
Perform a smart jump (or open an overview) to the reference under the mouse cursor.
\n
\n
smart_jump_under_cursor and overview_under_cursor
\n
Perform a smart jump (or open an overview) to the reference under the mouse cursor.
\n
\n
close_overview
\n
Close the overview window.
\n
\n
visual_mark_under_cursor
\n
Place a visual mark (ruler) under the mouse cursor.
\n
\n
close_visual_mark
\n
Exit the visual mark (ruler) mode.
\n
\n
zoom_in_cursor and zoom_out_cursor
\n
Zoom in/out on the mouse cursor.
\n
\n
zoom_in_cursor and zoom_out_cursor
\n
Zoom in/out on the mouse cursor.
\n
\n
goto_left, goto_right, goto_top_of_page and goto_bottom_of_page
\n
Go to the left/right/top/bottom of the current page.
\n
\n
goto_left, goto_right, goto_top_of_page and goto_bottom_of_page
\n
Go to the left/right/top/bottom of the current page.
\n
\n
goto_left, goto_right, goto_top_of_page and goto_bottom_of_page
\n
Go to the left/right/top/bottom of the current page.
\n
\n
goto_left, goto_right, goto_top_of_page and goto_bottom_of_page
\n
Go to the left/right/top/bottom of the current page.
\n
\n
goto_left_smart and goto_right_smart
\n
Go to the left/right side of the current page ignoring white margins.
\n
\n
goto_left_smart and goto_right_smart
\n
Go to the left/right side of the current page ignoring white margins.
\n
\n
rotate_clockwise and rotate_counterclockwise
\n
Rotate the document.
\n
\n
rotate_clockwise and rotate_counterclockwise
\n
Rotate the document.
\n
\n
goto_next_highlight and goto_prev_highlight
\n
Go to the next/previous highlight in the current document.
\n
\n
goto_next_highlight and goto_prev_highlight
\n
Go to the next/previous highlight in the current document.
\n
\n
goto_next_highlight_of_type and goto_prev_highlight_of_type
\n
Go to the next/previous highlight in the current document with following symbol's type.
\n
\n
goto_next_highlight_of_type and goto_prev_highlight_of_type
\n
Go to the next/previous highlight in the current document with following symbol's type.
\n
\n
add_highlight_with_current_type
\n
Add a highlight with the type specified using set_select_highlight_type.
\n
\n
enter_password
\n
Enter the password for password-protected documents.
\n
\n
toggle_fastread
\n
Highlight the first few characters of each word. Supposedly it may increase reading speed (unconfirmed).
\n
\n
new_window
\n
Open a new sioyek window.
\n
\n
toggle_statusbar
\n
Toggle the statusbar at the bottom of the screen.
\n
\n
reload
\n
Reload the current document.
\n
\n
synctex_under_cursor
\n
Perform a synctex search for the location under mouse cursor.
\n
\n
set_status_string
\n
Set a message to be displayed in sioyek's statusbar.
\n
\n
clear_status_string
\n
Clear the message in sioyek's statusbar.
\n
\n
toggle_titlebar
\n
Toggle the window titlebar.
\n
\n
next_preview and previous_preview
\n
If there are multiple possible previews for the overview window, move to the next/previous preview.
\n
\n
next_preview and previous_preview
\n
If there are multiple possible previews for the overview window, move to the next/previous preview.
\n
\n
goto_overview and portal_to_overview
\n
Go to / create a portal to the location displayed in the overview window.
\n
\n
goto_overview and portal_to_overview
\n
Go to / create a portal to the location displayed in the overview window.
\n
\n
goto_selected_text
\n
Jump to the location of current selected text.
\n
\n
focus_text
\n
If in visual mark (ruler) mode, focus the ruler on the line corresponding to the entered text.
\n
\n
goto_window
\n
Open a searchable list of sioyek windows.
\n
\n
overview_to_portal
\n
Open the overview window to the closest portal to current document location.
\n
\n
select_rect
\n
Select a rectangle (can be used in extensions using %{selected_rectangle} variable).
\n
\n
donate
\n
Open donation page.
\n
\n
overview_next_item and overview_prev_item
\n\n", "overview_prev_item": "\n
overview_next_item and overview_prev_item
\n\n"}
================================================
FILE: data/config_docs.json
================================================
{"background_color": "\n
background_color
\n
Specifies the background color of the app (this is different from the background color of PDF page which is configured using :ref:`customcolor`, this color is only shown when the displayed page is smaller than the srceen). The syntax to set colors is:
\n
\n
System Message: ERROR/3 (<string>, line 3); backlink
\nUnknown interpreted text role "ref".
\n
\nbackground_color r g b\n
\n
where r,g and b red, green and blue values between 0 and 1. For example in order to set the background color to gray we can add the following to our prefs_user.config:
\n
\nbackground_color 0.5 0.5 0.5\n
\n
\n
dark_mode_background_color
\n
Specifies the background color when dark mode is enabled.
\n
\n
dark_mode_contrast
\n
White text in dark mode can be annoying for the eyes. This option allows us to dim the white colors when dark mode is enabled. Allowed values are between 0.0 and 1.0.
\n
\n
text_highlight_color
\n
Highlight color when text is selected using mouse.
\n
\n
visual_mark_color
\n
This is the color of the transparent visual mark explained in :ref:`usage:Visual Mark` (this feature originally had an entirely different functionality which is why it is called vertical line even though there is nothing vertical about it!).\nAllowed values are RGBA colors between 0.0 and 1.0. For example, to set the color to a transparent red we add the following to our prefs_user.config:
\n
\n
System Message: ERROR/3 (<string>, line 4); backlink
\nUnknown interpreted text role "ref".
\n
\nvisual_mark_color 1.0 0.0 0.0 0.1\n
\n
\n
ruler_mode
\n
If it is 1, we highlight a rectangle around the current line in visual mark mode. Otherwise, we highlight below the current line.
\n
\nruler_mode 1\n
\n
\n
ruler_padding and ruler_x_padding
\n
Additional padding for ruler. Makes the ruler a little larger and more readable.
\n
\nruler_padding 1.0\nruler_x_padding 5.0\n
\n
\n
ruler_padding and ruler_x_padding
\n
Additional padding for ruler. Makes the ruler a little larger and more readable.
\n
\nruler_padding 1.0\nruler_x_padding 5.0\n
\n
\n
visual_mark_next_page_fraction
\n
When we go to the next page while in visual mark mode, this setting determines which location of screen the new line should be located at. The values are between -1 and 1. With 0 being the middle of the screen and 1 and -1 being the top and bottom of the screen respectively.
\n
\nvisual_mark_next_page_fraction 0.5\n
\n
\n
visual_mark_next_page_threshold
\n
Determines at which point in screen we move to the next page. Acceptable range is between 0 and visual_mark_next_page_fraction.
\n
\n
search_highlight_color
\n
The color used to highlight search results.
\n
\n
link_highlight_color
\n
The color used to highlight links in PDF files.
\n
\n
synctex_highlight_color
\n
Highlight color for synctex forward search highlights.
\n
\n
search_url_a to search_url_z
\n
The web addresses used for performing external_search command. (see :ref:`usage:External Search`). Example:
\n
\n
System Message: ERROR/3 (<string>, line 4); backlink
\nUnknown interpreted text role "ref".
\n
\nsearch_url_g https://www.google.com/search?q=\n
\n
\n
middle_click_search_engine and shift_middle_click_search_engine
\n
The letter corresponding to search_url_* configs to use when middle clicking/shift-middle clicking on text.\nExample:
\n
\nmiddle_click_search_engine g\n
\n
This causes the search engine configures using search_url_g to be used when middle clicking on text.
\n
\n
middle_click_search_engine and shift_middle_click_search_engine
\n
The letter corresponding to search_url_* configs to use when middle clicking/shift-middle clicking on text.\nExample:
\n
\nmiddle_click_search_engine g\n
\n
This causes the search engine configures using search_url_g to be used when middle clicking on text.
\n
\n
zoom_inc_factor
\n
The fraction by which we enlarge the page when zooming in/out.
\n
\n
wheel_zoom_on_cursor
\n
If set, when using mouse wheel to zoom we zoom in on mouse cursor instead of middle of screen.
\n
\n
vertical_move_amount and horizontal_move_amount
\n
How many inches we move vertically/horizontally when performing move_* commands.
\n
\n
vertical_move_amount and horizontal_move_amount
\n
How many inches we move vertically/horizontally when performing move_* commands.
\n
\n
move_screen_ratio
\n
The fraction of screen by which we move when executing screen_down and screen_up commands. (note that despite the name, the values are fractions between 0 and 1, not percentages)
\n
\n
flat_toc
\n
Displays a simplified flat table of contents instead of a hierarchial one. This can improve performance for documents with very large number of table of contents entries (thousands).\nAcceptable values are 0 and 1.
\n
\n
collapsed_toc
\n
If set, we initially collapse all table of content entries.
\n
\n
should_use_multiple_monitors
\n
If it is 1, when launching the application if we detect multiple monitors, we automatically launch the helper window in second monitor.\nAcceptable values are 0 and 1.
\n
\n
should_load_tutorial_when_no_other_file
\n
If the last opened document is empty, load the tutorial pdf instead.
\n
\n
should_launch_new_instance
\n
\n
Warning
\n
This is deprecated. Use should_launch_new_window instead.
\n
\n
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.
\n
\n
should_launch_new_window
\n
If it is 0, then we use the previous window of sioyek when opening a new file, otherwise a new window is opened every time we open a new file.
\n
\n
inverse_search_command
\n
The command to use when trying to do inverse search into a LaTeX document. %1 expands to the name of the file and %2 expans to the line number. For example:
\n
\ninverse_search_command "C:\\path\\to\\vscode\\Code.exe" -r -g %1:%2\n
\n
\n
highlight_color_a to highlight_color_z
\n
The color to use for highlights of type a to z.
\n
\n
should_draw_unrendered_pages
\n
If set, we display a checkerboard pattern for unrendered pages (by default we display nothing).
\n
\n
rerender_overview
\n
Normally we reuse the rendered page for overview window. This may cause the overview page to be blurry or too sharp if there is a significant difference between the zoom levels of the main window and overview window.\nIf rerender_overview is set, we rerender overview which solves this issue at the cost of some additional computation.
\n
\nrerender_overview 1\n
\n
\n
default_dark_mode
\n
Use dark mode by default.
\n
\n
sort_bookmarks_by_location
\n
If set, we sort the bookmarks by their location instead of their creation time.
\n
\n
shared_database_path
\n
The path of shared.db database file. You can set this path to be in a synchronized folder (for example a dropbox folder) and sioyek data will be automatically synchronized across your devices.
\n
\n
font_size
\n
Size of the UI font.
\n
\n
ui_font
\n
The font to use for UI text.
\n
\nui_font Segoe UI Emoji\n
\n
\n
item_list_prefix
\n
A prefix character to use before list of items (for example can be used to display a checkmark before each of the bookmarks).
\n
\nitem_list_prefix \u2714\ufe0f\n
\n
\n
check_for_updates_on_startup
\n
If set, sioyek checkes for new versions on startup and notifies the user if a new version if available.
\n
\ncheck_for_updates_on_startup 1\n
\n
\n
custom_background_color and custom_text_color
\n
Specify the background and text color when using custom color mode (by executing toggle_custom_color command).
\n
\ncustom_background_color 0.18 0.20 0.25\ncustom_text_color 1.0 1.0 1.0\n
\n
\n
custom_background_color and custom_text_color
\n
Specify the background and text color when using custom color mode (by executing toggle_custom_color command).
\n
\ncustom_background_color 0.18 0.20 0.25\ncustom_text_color 1.0 1.0 1.0\n
\n
\n
startup_commands
\n
Semicolon-separated list of commands to execute on startup. For example, to start in custom color mode and in visual scroll mode, you can add the following (the command names are the same as the ones displayed when opening the command window using :):
\n
\nstartup_commands toggle_custom_color;toggle_visual_scroll\n
\n
\n
status_bar_color, status_bar_text_color and status_bar_font_size
\n
Allow you to customize the appearance of status bar.
\n
\nstatus_bar_color 0 0 0\nstatus_bar_text_color 1 1 1\nstatus_bar_font_size 10\n
\n
\n
status_bar_color, status_bar_text_color and status_bar_font_size
\n
Allow you to customize the appearance of status bar.
\n
\nstatus_bar_color 0 0 0\nstatus_bar_text_color 1 1 1\nstatus_bar_font_size 10\n
\n
\n
status_bar_color, status_bar_text_color and status_bar_font_size
\n
Allow you to customize the appearance of status bar.
\n
\nstatus_bar_color 0 0 0\nstatus_bar_text_color 1 1 1\nstatus_bar_font_size 10\n
\n
\n
execute_command_a to execute_command_z
\n
Predefined shell commands to be executed using execute_predefined_command. %1 expands to the path of the current file, %2 expands to name of the current file and %3 expands to current selected text.\nFor example, suppose you have a command named ocr which takes a file path and produces an OCR'd version of the document. You can add the following to you prefs_user.config:
\n
\nexecute_command_o ocr "%1"\n
\n
You can later quickly invoke this command by executing execute_predefined_command and then pressing o.
\n
\n
Warning
\n
The command parsing code in sioyek is not very good. For example it can not handle multiple commands like command1 args;command2 or commands that include spaces. If you want to run a complex command, first put all commands in a script file and then run the script file using using sioyek like this: /path/to/script.sh %1 %2 %3.
\n
\n
\n
papers_folder_path
\n
Path to a directory on your computer. Sioyek monitors the changes in this directory and if a new file is added to this directory while we have a pending portal, this file is automatically used as the destination of the portal. This is useful when creating a portal from a reference in a paper to the actual reference file.
\n
\n
display_resolution_scale
\n
Manual resolution scaling. Can be useful for some very high resolution displays which report the wrong resolution.
\n
\n
linear_filter
\n
If set, we use linear texture filtering instead of the normal nearest neighbour filtering. This is useful when using manual display resolution scale which causes the nearest neighbour filter to look bad.
\n
\n
main_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_move
\n
Configures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\n
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n
\n
\n
main_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_move
\n
Configures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\n
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n
\n
\n
main_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_move
\n
Configures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\n
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n
\n
\n
main_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_move
\n
Configures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\n
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n
\n
\n
main_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_move
\n
Configures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\n
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n
\n
\n
main_window_size, main_window_move, helper_window_size, helper_window_move, single_main_window_size and single_main_window_move
\n
Configures the size and position of the main window and the helper window. single_main_window_* is used when helper window is closed and the other configs are used when both windows are opened.\nThese values are automatically written to auto.cong file when sioyek exits but you can manually override them by setting them in your prefs_user.config.
\n
\nsingle_main_window_size 1824 988\nsingle_main_window_move 22 21\nmain_window_size 1824 988\nmain_window_move 18 44\nhelper_window_size 1891 1033\nhelper_window_move 1951 0\n
\n
\n
touchpad_sensitivity
\n
Can be used to adjust the sensitivity of the touchpad.
\n
\ntouchpad_sensitivity 0.1\n
\n
\n
page_separator_width and page_separator_color
\n
Used to adjust the appearance of page separator.
\n
\npage_separator_width 2\npage_separator_color 0.5 0.5 0.5\n
\n
\n
page_separator_width and page_separator_color
\n
Used to adjust the appearance of page separator.
\n
\npage_separator_width 2\npage_separator_color 0.5 0.5 0.5\n
\n
\n
fit_to_page_width_ratio
\n
Ratio of screen width to use when using fit_to_screen_width_ratio command. Can be useful for very wide screens.
\n
\nfit_to_page_width_ratio 0.75\n
\n
\n
create_table_of_contents_if_not_exists
\n
If set and the file doesn't have a table of contents, we use heuristic methods to create a table of contents. You can use max_created_toc_size to prevent creating very large table of contents.
\n
\ncreate_table_of_contents_if_not_exists 1\nmax_created_toc_size 5000\n
\n
\n
force_custom_line_algorithm
\n
Use legacy line detection algorithm instead of the mupdf one.
\n
\n
overview_size and overview_offset
\n
Adjust the size of overview window. The values are in normalized window coordinates between -1 and 1.
\n
\noverview_size 0.852604 0.597729\noverview_offset -0.0119792 0.120151\n
\n
\n
overview_size and overview_offset
\n
Adjust the size of overview window. The values are in normalized window coordinates between -1 and 1.
\n
\noverview_size 0.852604 0.597729\noverview_offset -0.0119792 0.120151\n
\n
\n
show_doc_path
\n
Show the full document path instead of just the file name in list of recently opened documents.
\n
\n
should_warn_about_user_key_override
\n
If set, we warn the user in command line when overriding already degined keybinds.
\n
\n
single_click_selects_words
\n
If set, single clicking and dragging mouse selects entire words rather than characters.
\n
\n
shift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_command
\n
Custom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n
\ncontrol_click_command overview_under_cursor\n
\n
If set, single clicking and dragging mouse selects entire words rather than characters.
\n
\n
shift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_command
\n
Custom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n
\ncontrol_click_command overview_under_cursor\n
\n
If set, single clicking and dragging mouse selects entire words rather than characters.
\n
\n
shift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_command
\n
Custom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n
\ncontrol_click_command overview_under_cursor\n
\n
If set, single clicking and dragging mouse selects entire words rather than characters.
\n
\n
shift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_command
\n
Custom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n
\ncontrol_click_command overview_under_cursor\n
\n
If set, single clicking and dragging mouse selects entire words rather than characters.
\n
\n
shift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_command
\n
Custom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n
\ncontrol_click_command overview_under_cursor\n
\n
If set, single clicking and dragging mouse selects entire words rather than characters.
\n
\n
shift_click_command, control_click_command, alt_click_command, shift_right_click_command, control_right_click_command, and alt_right_click_command
\n
Custom commands to run when mouse click is pressed while modifier keys are held down. For example:
\n
\ncontrol_click_command overview_under_cursor\n
\n
If set, single clicking and dragging mouse selects entire words rather than characters.
\n
\n
use_legacy_keybinds
\n
By default we use legacy keybindings which have some problems. For example to bind the % key, you would have to enter something like this:
\n
\ncommand <S-%>\n
\n
which is a little weird. Also legacy keybinds don't work well with some keyboard layouts. If you set use_legacy_keybinds to 0, then we use a new method for keybind parsing which allows you to do something like this:
\n
\ncommand %\n
\n
which also works with all keyboard layouts. Since this is a backwards incompatible change, use_legacy_keybinds is activated by default.
\n
\n
start_with_helper_window
\n
Open helper window when sioyek starts.
\n
\n
prerender_next_page_presentation
\n
When in presentation mode, we pre-render the next page to remove flickering when moving between pages.
\n
\n
highlight_middle_click
\n
If enabled, highlights the selected text by middle clicking on it.
\n
\n
super_fast_search
\n
If enabled, indexes the document text and considerably speeds of searching. It also enables regex_search command which uses the index to search for regular expressions.
\n
\n
show_closest_bookmark_in_statusbar
\n
If enabled, displays the text for closest bookmark in the statusbar.
\n
\n
show_close_portal_in_statusbar
\n
If enabled, it displays a statusbar message when we are close to a portal.
\n
\n
prerender_page_count
\n
The number of pages to prerender. The larger it is, the more memory we use but there will be less flickering when quickly moving pages.
\n
\n
case_sensitive_search
\n
It is enabled by default. If disabled, we use case-insensitive searching.
\n
\n
show_document_name_in_statusbar
\n
Displays the document name in sioyek's statusbar.
\n
\n
ui_background_color and ui_text_color
\n
The background and text color of (unselected) UI elements.
\n
\n
ui_background_color and ui_text_color
\n
The background and text color of (unselected) UI elements.
\n
\n
ui_selected_background_color and ui_selected_text_color
\n
The background and text color of selected UI elements.
\n
\n
ui_selected_background_color and ui_selected_text_color
\n
The background and text color of selected UI elements.
\n
\n
source
\n
Includes another config file, which is useful for themes and extensions.
\n
\n# includes file.config in this configuration file\n
\n
================================================
FILE: android/AndroidManifest.xml
================================================