Skip to content
This repository was archived by the owner on Aug 27, 2022. It is now read-only.

Commit

Permalink
Add initial offline manual
Browse files Browse the repository at this point in the history 
- manual can be accessed via localhost/manual

Change-Id: I5d0ca14f8b7b2b0a7e0f478cf241ce7a9a16625e
  • Loading branch information
@andi34
andi34 committed Jun 1, 2020
1 parent 2977cf3 commit d55b850
Show file tree
Hide file tree
Showing 4 changed files with 339 additions and 1 deletion.
106 changes: 106 additions & 0 deletions manual/index.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
<?php

require_once('../lib/config.php');
require_once('../lib/configsetup.inc.php');

?>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0 user-scalable=no">
<meta name="msapplication-TileColor" content="<?=$config['colors']['primary']?>">
<meta name="theme-color" content="<?=$config['colors']['primary']?>">

<title>Photobooth Manual</title>

<!-- Favicon + Android/iPhone Icons -->
<link rel="apple-touch-icon" sizes="180x180" href="../resources/img/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="../resources/img/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="../resources/img/favicon-16x16.png">
<link rel="manifest" href="../resources/img/site.webmanifest">
<link rel="mask-icon" href="../resources/img/safari-pinned-tab.svg" color="#5bbad5">

<link rel="stylesheet" type="text/css" href="../node_modules/normalize.css/normalize.css" />
<link rel="stylesheet" type="text/css" href="../node_modules/font-awesome/css/font-awesome.css" />
<link rel="stylesheet" type="text/css" href="../resources/css/manual.css" />
<?php if ($config['rounded_corners']): ?>
<link rel="stylesheet" type="text/css" href="../resources/css/rounded.css" />
<?php endif; ?>
</head>
<body class="manualwrapper">
<div class="manual-panel">
<h2>Photobooth Manual</h2>
<h3><a class="back-to-pb" href="../">Photobooth</a></h3>

<div class="accordion">
<form>
<?php
$i = 0;
foreach($configsetup as $panel => $fields) {
$open = '';
if($i == 0){
$open = ' open init';
}
echo '<div class="panel'.$open.'">';
echo '<div class="panel-heading">';
echo '<h3><span class="minus">-</span><span class="plus">+</span><span data-i18n="'.$panel.'">'.$panel.'</span></h3>';
echo '</div>';
echo '<div class="panel-body">';

foreach($fields as $key => $field) {
echo '<div class="form-row">';
switch($field['type']) {
case 'checkbox':
echo '<p><h4><span data-i18n="'.$key.'">'.$key.'</span></h4></p>';
echo '<p><span data-i18n="manual_'.$key.'">manual_'.$key.'</span></p><hr>';
echo '</div>';
break;
case 'multi-select':
case 'range':
case 'select':
case 'input':
echo '<p><h4><span data-i18n="'.$panel.'_'.$key.'"></span></h4></p>';
echo '<p><span data-i18n="manual_'.$panel.'_'.$key.'">manual_'.$panel.'_'.$key.'</span></p><hr>';
echo '</div>';
break;
case 'color':
case 'hidden':
echo '<input type="hidden" name="'.$field['name'].'" value="'.$field['value'].'"/>';
echo '</div>';
break;
}
}
echo '</div>';
echo '</div>';
$i++;
}
?>
</form>
<a href="https://github.com/andi34/photobooth/wiki" class="btn wiki-btn"><span data-i18n="show_wiki"></span></a>
</div>
</div>

<script type="text/javascript" src="../api/config.php"></script>
<script type="text/javascript" src="../node_modules/jquery/dist/jquery.min.js"></script>
<script type="text/javascript" src="../resources/js/theme.js"></script>
<script type="module" src="../resources/js/i18n-sub.js"></script>

<script>
$(function() {
$('.panel-heading').on('click', function() {
const panel = $(this).parents('.panel');
const others = $(this).parents('.accordion').find('.open').not(panel);

others.removeClass('open init');

panel.toggleClass('open');
panel.find('.panel-body').slideToggle();

others.find('.panel-body').slideUp('fast');
});
});
</script>

</body>
</html>
114 changes: 114 additions & 0 deletions resources/lang/en.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,119 @@
"mail_subject": "Subject",
"mail_text": "Text",
"mail_username": "Username of the e-mail account",
"manual_allow_delete": "If enabled pictures can be deleted on result page directly after they have been taken.",
"manual_chroma_keying": "Enter the path and name used for the Chromakeying Folder. This should be a subfolder of your \"data\" folder!",
"manual_commands_exiftool_cmd": "EXIFtool commandline which is executed after taking a picture if \"Preserve EXIF data\" is enabled.",
"manual_commands_exiftool_msg": "Message returned from EXIFtool commandline.",
"manual_commands_print_cmd": "Commandline which is executed while pressing the \"Print\" button.",
"manual_commands_print_msg": "Message returned from print command.",
"manual_commands_take_picture_cmd": "Commandline which is executed while pressing the \"Take Pic\" button. On Linux you can for example use <a href=\"http://www.gphoto.org\" target=\"_blank\">gphoto2</a> to take pictures, on Windows you can use <a href=\"http://digicamcontrol.com\" target=\"_blank\">digiCamControl</a>.",
"manual_commands_take_picture_msg": "Message returned from take picture command.",
"manual_continuous_collage": "Take collage without interupption.",
"manual_crop_onprint": "If enabled, pictures are cropped at print by given height and width.",
"manual_cups_button": "Show a button on startpage to easily access CUPS (Common Unix Printing System).",
"manual_dev": "Enables development mode. Sample pictures will be used instead taking a picture.",
"manual_event_symbol": "Choose a symbol which is shown between entered text.",
"manual_event_textLeft": "Enter the text visible on the left side of the choosen symbol.",
"manual_event_textRight": "Enter the text visible on the right side of the choosen symbol.",
"manual_file_format_date": "If enabled, date formatted image names are used. This also gives the possibility to show date and time of the image inside the gallery.",
"manual_folders_data": "Enter name of your data folder.",
"manual_folders_images": "Enter the path and name used for the Image Folder. This should be a subfolder of your \"data\" folder!",
"manual_folders_keying": "If enabled, chromakeying can be accessed from gallery for your pictures.",
"manual_folders_print": "Enter the path and name used for the Print Folder. This should be a subfolder of your \"data\" folder!",
"manual_folders_qrcodes": "Enter the path and folder used for the QR Folder. This should be a subfolder of your \"data\" folder!",
"manual_folders_thumbs": "Enter the path and name used for the Thumbnail Folder. This should be a subfolder of your \"data\" folder!",
"manual_folders_tmp": "Enter the path and name used for the TEMP Folder. This should be a subfolder of your \"data\" folder!",
"manual_force_buzzer": "If enabled, the take picture and collage buttons disappear. You now get a button which tells to use a buzzer to take a picture or collage.",
"manual_gallery_date_format": "Enter your date style.",
"manual_general_camera_mode": "Choose between front- and backfacing camera mode of your device cam.",
"manual_general_cheese_time": "Choose a time \"Cheeeeeeeese!\" is shown after countdown.",
"manual_general_cntdwn_time": "Set your countdown time.",
"manual_general_collage_cntdwn_time": "Set your countdown time between pictures while taking a collage.",
"manual_general_collage_key": "Specify the key id to use that key to take a collage (e.g. 13 is the enter key). For example use <a href=\"https://keycode.info\" target=\"_blank\">https://keycode.info</a> to find out the key id.",
"manual_general_default_imagefilter": "Choose an imagefilter which is applied by default after taking a picture.",
"manual_general_disabled_filters": "Choose filters which get removed from the available imagefilter.",
"manual_general_ipCamPreviewRotation": "Choose to rotate the preview from URL.",
"manual_general_ipCamURL": "CSS style to use a stream from an URL for preview at countdown. <p>Example: <code>url(../img/bg_bluegray.jpg)</code></p>",
"manual_general_language": "Choose interface language.<p>If you're missing a language or like to help improving translations visit the <a href=\"https://github.com/andi34/photobooth/wiki/FAQ#how-to-update-or-add-translations\" target=\"_blank\">\"How to update or add translations?\"</a> inside the Photobooth Wiki for instructions.</p>",
"manual_general_photo_key": "Specify the key id to use that key to take a picture (e.g. 13 is the enter key). For example use <a href=\"https://keycode.info\" target=\"_blank\">https://keycode.info</a> to find out the key id.",
"manual_general_pictureRotation": "Add a value which will set the degrees a picture is rotated after taking it.",
"manual_general_polaroid_rotation": "Enter a value which is used as degrees a picture gets rotated with polaroid effect.",
"manual_general_start_screen_subtitle": "Enter the subtitle visible on startpage.",
"manual_general_start_screen_title": "Enter the title visible on startpage",
"manual_general_take_frame_path": "Enter the path of the frame which is applied to your picture after taking it.",
"manual_general_time_to_live": "Enter a value used as milliseconds. This value defines the time your picture is visible on the result screen after taking a picture.",
"manual_general_videoHeight": "Add a value which is used as height for preview by device cam.",
"manual_general_videoWidth": "Add a value which is used as width for preview by device cam.",
"manual_general_webserver_ip": "Please define the IP address of the Photobooth web server to make the QR-Code working if you're accessing Photobooth via \"localhost\", \"127.0.0.1\" or if you have Photobooth installed inside a subfolder. <p>Example if Photobooth can be accessed directly: <code>192.168.0.50</code>.</p><p>Example if Photobooth is installed inside a subfolder: <code>192.168.0.50/photobooth</code>.</p>",
"manual_image_preview_before_processing": "If enabled, images are preloaded and shown during filter processing.",
"manual_is_event": "If enabled, you can define a text and choose between different symbols which are visible on the start page.",
"manual_is_textonprint": "If enabled, you can print some text on top of your pictures.",
"manual_jpeg_quality_jpeg_quality_chroma": "Picture quality used for chromakeying pictures.",
"manual_jpeg_quality_jpeg_quality_image": "Picture quality used for taking pictures.",
"manual_jpeg_quality_jpeg_quality_thumb": "Picture quality used for thumbnails.",
"manual_keep_images": "If enabled, original images will be kept inside tmp folder.",
"manual_login_enabled": "If enabled, a username and password will be needed to access the adminpage and/or start screen (depending on your setup).",
"manual_login_password": "Define your password used for login. Please note: after saving your password will only be visible as a hash inside adminpanel. For login don't enter the hash, enter the password you have set.",
"manual_login_username": "Define the username used to login into Photobooth.",
"manual_mail_fromAddress": "Enter your return address which is used while sending pictures via email.",
"manual_mail_fromName": "Enter your sender name which is used while sending pictures via email.",
"manual_mail_host": "Enter your email host adress.",
"manual_mail_password": "Enter your password used to login into your email account.",
"manual_mail_port": "Enter the port used for email.",
"manual_mail_secure": "Enter used SSL-protocol (tls or ssl) used to send emails.",
"manual_mail_subject": "Enter the subject used while sending pictures via email.",
"manual_mail_text": "Enter the mail text which is used while sending pictures via email.",
"manual_mail_username": "Enter the username used to login into your email account.",
"manual_newest_first": "If enabled, latest images will be shown first inside the gallery.",
"manual_polaroid_effect": "If enabled, a polaroid effect is applied to your picture after it was taken.",
"manual_preserve_exif_data": "If enabled, EXIF data is preserved while taking pictures. Please setup the \"EXIFtool command\" inside the \"Commands\" tab.",
"manual_previewCamFlipHorizontal": "If enabled, preview by device cam is flipped horizontal.",
"manual_previewCamTakesPic": "If enabled, a picture is taken from device cam instead executing the \"Take picture command\". Please note that the resolution depends on the given hight and width because it's acts like taking a screenshot.",
"manual_previewFromCam": "If enabled, a preview by your device cam is used at countdown. Preview by \"device cam\" will always use the camera of the device where Photobooth get opened in a Browser (e.g. on a tablet it will always show the tablet camera while on a smartphone it will always show the smartphone camera instead)! A secure origin or exception is required! You can find out how to set an exception <a href=\"https://medium.com/@Carmichaelize/enabling-the-microphone-camera-in-chrome-for-local-unsecure-origins-9c90c3149339\" target=\"_blank\">here</a>.",
"manual_previewFromIPCam": "If enabled, a preview by defined url will be visible at countdown. Make sure to have a stream available you can use (e.g. from your Webcam, Smartphone Camera or Raspberry Pi Camera).",
"manual_print_crop_height": "Enter a value for the height which is used for the picture if \"Crop picture at print\" is enabled.",
"manual_print_crop_width": "Enter a value for the width which is used for the picture if \"Crop picture at print\" is enabled.",
"manual_print_font_path": "Enter the path to the font used to print text on your image.",
"manual_print_fontsize": "Enter the fontsize used to print text on your image.",
"manual_print_frame": "If enabled, a frame is applied on your picture at print.",
"manual_print_frame_path": "Enter the path of the frame which is applied to your picture at print.",
"manual_print_line1": "Text used for 1. Line which gets printed on your picture.",
"manual_print_line2": "Text used for 2. Line which gets printed on your picture.",
"manual_print_line3": "Text used for 3. Line which gets printed on your picture.",
"manual_print_linespace": "Enter used linespace while printing text on your picture.",
"manual_print_locationx": "X-Coordinates of the text while printing text on your picture.",
"manual_print_locationy": "Y-Coordinates of the text while printing text on your picture.",
"manual_print_qrcode": "If enabled, a QR-Code is printed on the right side of the picture while printing.",
"manual_print_rotation": "Enter a value which is used as degrees a picture gets rotated at print.",
"manual_protect_admin": "If enabled, admin panel can only be accessed if a username and password is entered.",
"manual_protect_index": "If enabled, start screen can only be accessed if a username and password is entered.",
"manual_randomPicture": "If enabled, random pictures will be shown at standalone gallery.",
"manual_remove_config": "If enabled, personal config gets removed on reset.",
"manual_remove_images": "If enabled, all images gets removed on reset.",
"manual_remove_mailtxt": "If enabled, mail database gets removed on reset.",
"manual_rounded_corners": "If enabled, the Photobooth UI uses smooth rounded edges.",
"manual_scrollbar": "If enabled, a scrollbar is visible in gallery.",
"manual_send_all_later": "If enabled, entered email adresses get stored inside a database instead sending choosed picture directly. For example, this can be used to send a mail with all pictures or a link to an online gallery after the event.",
"manual_show_date": "If enabled, date and time is visible below the image inside the gallery and standalone slideshow.",
"manual_show_error_messages": "If enabled real error messages are shown on error.",
"manual_show_fork": "If enabled, a fork badge is shown on the right upper corner on the start screen.",
"manual_show_gallery": "If enabled, user can access the gallery from start screen.",
"manual_slideshow_pictureTime": "Add a value which is used as milliseconds an image is displayed at slideshow.",
"manual_slideshow_refreshTime": "Refresh slideshow page afert entered seconds.",
"manual_take_frame": "If enabled, defined frame will be applied to your picture after taking it.",
"manual_toggle_fs_button": "If enabled, a button to toggle fullscreenmode will be added to the start screen.",
"manual_use_collage": "If enabled, user can take a collage. A collage consists of 4 pictures. Optional you can take a collage with or without interruption.",
"manual_use_download": "If enabled, a download button is visible on each picture inside the gallery.",
"manual_use_filter": "If enabled, user can choose a imagefiler after taking a picture.",
"manual_use_mail": "If enabled, a email button is visible on each picture inside the gallery. Depending on your setup you can send pictures via email directly or collect entered email address inside a database.",
"manual_use_print": "If enabled, a print button is visible on result screen, gallery and chromakeying page.",
"manual_use_qr": "If enabled, a QR-Button is visible on the result screen and inside gallery. User can download a picture while scanning the QR-Code. If you're accessing Photobooth via \"localhost\", \"127.0.0.1\" or if you have Photobooth installed inside a subfolder, please define IP address of the Photobooth web server to make the QR-Code working. <p>Example if Photobooth can be accessed directly: <code>192.168.0.50</code>.</p><p>Example if Photobooth is installed inside a subfolder: <code>192.168.0.50/photobooth</code>.</p>",
"manual_use_thumbs": "If enabled, thumbnails are used for standalone gallery. This will improve the performance slightly.",
"manual_user_interface_background_admin": "CSS Style for background on admin panel. For example you can define a \"url\" or a color.",
"manual_user_interface_background_chroma": "CSS Style for background on chromakeying page. For example you can define a \"url\" or a color.",
"manual_user_interface_background_image": "CSS Style for background on start-, login- and slideshow pages. For example you can define a \"url\" or a color.",
"manual_user_interface_font_size": "Enter the default fontsize used for the Photobooth interface.",
"milliseconds": "milliseconds",
"newCollage": "New Collage",
"newPhoto": "New Picture",
Expand Down Expand Up @@ -148,6 +261,7 @@
"show_error_messages": "Show error messages",
"show_fork": "Show Fork Badge",
"show_gallery": "Show Gallery",
"show_wiki": "Open Wiki (internet connection required)",
"slideshow": "Slideshow",
"slideshow_pictureTime": "Milliseconds an image is displayed",
"slideshow_refreshTime": "Refresh page afert X seconds",
Expand Down
Loading

0 comments on commit d55b850

Please sign in to comment.