Difference between revisions of "Interface"

From Nutcracker Wiki
Jump to: navigation, search
Line 10: Line 10:
  
 
{| class="wikitable" style="width: 100%; margin: auto; border-spacing: 2px; border: 2px solid; color:#5C92BC;"
 
{| class="wikitable" style="width: 100%; margin: auto; border-spacing: 2px; border: 2px solid; color:#5C92BC;"
−
! style="width:250px" | [//nutcracker123.com/w/images/x/XLNC-3-ProjectWindow.png 3.0 Project Window]
+
! style="width:250px" | [//nutcracker123.com/w/images/x/XLNC-ProjectWindow.png Project Window]
−
! style="width:250px" | XLNC 3.0 Project Window Pic
+
 
|- border="0"
 
|- border="0"
 
|- style="text-align: center; color:#000000;"
 
|- style="text-align: center; color:#000000;"
−
| 3.0 Project Window || 4.0 Project Window
+
| Project Window
 
|}<br>
 
|}<br>
  
Line 21: Line 20:
 
<br>
 
<br>
 
<h2 style="text-align:center; width: 20%; font-size:1.8em; margin:2px 0px; background:#5C92BC; color:#ffffff"> <span class="mw-headline" id="Menu Bar">'''Menu Bar'''</span></h2><hr>
 
<h2 style="text-align:center; width: 20%; font-size:1.8em; margin:2px 0px; background:#5C92BC; color:#ffffff"> <span class="mw-headline" id="Menu Bar">'''Menu Bar'''</span></h2><hr>
−
<div style="text-align:left; font-size:1em;"><u>'''3.0'''</u></div>
+
 
−
<br>
+
−
<div style="text-align:left; font-size:1em;"><u>'''4.0'''</u></div>
+
 
<br>
 
<br>
 
{| class="wikitable" style="width: 100%; margin: auto; border-spacing: 2px; border: 2px solid; color:#5C92BC;"
 
{| class="wikitable" style="width: 100%; margin: auto; border-spacing: 2px; border: 2px solid; color:#5C92BC;"
Line 34: Line 31:
 
| Playlist || Create, Save, Edit, and Delete Playlists; Create Custom Scripts
 
| Playlist || Create, Save, Edit, and Delete Playlists; Create Custom Scripts
 
|- style="color:#000000;"
 
|- style="color:#000000;"
−
| Export (4.0) ||
+
| Export ||
 
|- style="color:#000000;"
 
|- style="color:#000000;"
−
| Utilities (4.0) ||
+
| Utilities ||
 
|- style="color:#000000;"
 
|- style="color:#000000;"
 
| Settings || Disable Threaded Save
 
| Settings || Disable Threaded Save
Line 44: Line 41:
  
 
<div style="text-align:left; font-size:1.4em;">'''File Menu'''</div><hr><br>
 
<div style="text-align:left; font-size:1.4em;">'''File Menu'''</div><hr><br>
−
<div style="text-align:left; font-size:1em;"><u>'''3.0'''</u></div>
+
 
−
<br>
+
−
<div style="text-align:left; font-size:1em;"><u>'''4.0'''</u></div>
+
 
<br>
 
<br>
−
<div style="text-align:left; font-size:1em;"><u>'''New Sequence'''</u>(4.0)</div>
+
<div style="text-align:left; font-size:1em;"><u>'''New Sequence'''</u></div>
 
<br>
 
<br>
−
<div style="text-align:left; font-size:1em;"><u>'''Open Sequence'''</u>(4.0)</div>
+
<div style="text-align:left; font-size:1em;"><u>'''Open Sequence'''</u></div>
 
<br>
 
<br>
−
<div style="text-align:left; font-size:1em;"><u>'''Save Sequence'''</u>(4.0)</div>
+
<div style="text-align:left; font-size:1em;"><u>'''Save Sequence'''</u></div>
 
<br>
 
<br>
−
<div style="text-align:left;"><u>'''Select Show Folder'''</u>(Icon in 4.0 Only)</div>
+
<div style="text-align:left;"><u>'''Select Show Folder'''</u></div>
 
* Launches a file selection window where the user can designate the default show folder.  The location is where all xLights (.xml) files, export files, and media files are stored.
 
* Launches a file selection window where the user can designate the default show folder.  The location is where all xLights (.xml) files, export files, and media files are stored.
 
* Changing the location automatically saves the show folder location and reserves the location every time the user opens the application.
 
* Changing the location automatically saves the show folder location and reserves the location every time the user opens the application.
 
* Check out Tips and Tricks or ways to organize show directories.
 
* Check out Tips and Tricks or ways to organize show directories.
−
<div style="text-align:left;"><u>'''Backup'''</u>(Icon in 4.0 Only)</div>
+
<div style="text-align:left;"><u>'''Backup'''</u></div>
 
* Launches a confirm pop up box to perform a backup of all XML files under 10MB.
 
* Launches a confirm pop up box to perform a backup of all XML files under 10MB.
 
* The backup will create sub-folder (if one does not exist) within a user’s default show folder based on date the backup was confirmed.
 
* The backup will create sub-folder (if one does not exist) within a user’s default show folder based on date the backup was confirmed.
Line 64: Line 59:
  
 
{| class="wikitable" style="width: 100%; margin: auto; border-spacing: 2px; border: 2px solid; color:#5C92BC;"
 
{| class="wikitable" style="width: 100%; margin: auto; border-spacing: 2px; border: 2px solid; color:#5C92BC;"
−
! style="width:250px" | XLNC 3.0 Project Window Pic
+
! style="width:250px" | Confirmation Pop Up Box Pic
−
! style="width:250px" | XLNC 3.0 Project Window Pic
+
! style="width:250px" | Backup Folder and Location Pic
 
|- border="0"
 
|- border="0"
 
|- style="text-align: center; color:#000000;"
 
|- style="text-align: center; color:#000000;"
Line 75: Line 70:
 
{| class="wikitable" style="width: 100%; margin: auto; border-spacing: 2px; border: 2px solid; color:#5C92BC;"
 
{| class="wikitable" style="width: 100%; margin: auto; border-spacing: 2px; border: 2px solid; color:#5C92BC;"
 
|- style="text-align: left; color:#000000;"
 
|- style="text-align: left; color:#000000;"
−
| XLNC 3.0 Project Window Pic || If there are unsaved tasks (Playlists, Schedule, Nutcracker) an Alert pop up box alerts the user of unsaved changes.
+
| Quit Pic || If there are unsaved tasks (Playlists, Schedule, Nutcracker) an Alert pop up box alerts the user of unsaved changes.
 
* Click “Yes”, program closes without saving any updated/changed tasks.
 
* Click “Yes”, program closes without saving any updated/changed tasks.
 
* Click “No”, user can return and save changed/updated tasks.
 
* Click “No”, user can return and save changed/updated tasks.
Line 147: Line 142:
 
|}<br>
 
|}<br>
  
−
<div style="text-align:left; font-size:1.4em;">'''Export Menu'''4.0</div><hr><br>
+
<div style="text-align:left; font-size:1.4em;">'''Export Menu'''</div><hr><br>
  
−
<div style="text-align:left; font-size:1.4em;">'''Utilities Menu'''4.0</div><hr><br>
+
<div style="text-align:left; font-size:1.4em;">'''Utilities Menu'''</div><hr><br>
  
 
<div style="text-align:left; font-size:1.4em;">'''Settings Menu'''</div><hr><br>
 
<div style="text-align:left; font-size:1.4em;">'''Settings Menu'''</div><hr><br>

Revision as of 03:40, 18 August 2015


Guide to the Project Window/Interface

Project Window
Project Window

Title Bar

  • Indicates the latest build of the xLights/Nutcracker software. If an error or “bug” occurs, have this number available and send “bugs” or errors to the wiki or forum for resolution.


Menu Bar


Menu Description
File Contains pull-down menus to update the Show Folder Location; Create backups; Exit the Software.
Playlist Create, Save, Edit, and Delete Playlists; Create Custom Scripts
Export
Utilities
Settings Disable Threaded Save
Help Short and detailed Help documents; license, build, and acknowledgments.

File Menu


New Sequence


Open Sequence


Save Sequence


Select Show Folder
  • Launches a file selection window where the user can designate the default show folder. The location is where all xLights (.xml) files, export files, and media files are stored.
  • Changing the location automatically saves the show folder location and reserves the location every time the user opens the application.
  • Check out Tips and Tricks or ways to organize show directories.
Backup
  • Launches a confirm pop up box to perform a backup of all XML files under 10MB.
  • The backup will create sub-folder (if one does not exist) within a user’s default show folder based on date the backup was confirmed.
  • View the Restore section for restoring from backup.
Confirmation Pop Up Box Pic Backup Folder and Location Pic
Confirmation Pop Up Box Example of Backup Folder and Location

Quit
  • Closes application.
Quit Pic If there are unsaved tasks (Playlists, Schedule, Nutcracker) an Alert pop up box alerts the user of unsaved changes.
  • Click “Yes”, program closes without saving any updated/changed tasks.
  • Click “No”, user can return and save changed/updated tasks.

Note: Any changes to the following tabs will not launch an Alert Box: Test, Convert, Preview, and Papagayo and any changes made will not be saved unless the user saves or completes the task, depending on the tool used.


Recent File List
  • Lists the last “4” Show Folder locations used/referenced.


Playlist Menu

Save Playlists
  • Saves user created playlists.
Add
  • Creates playlists (adds a tab) to the workspace screen.
  • Launches a prompt box to allow the user assign a unique name and create a playlist from Audio, Video, and xLights files from the default show directory.
XLNC Add Playlist Pic

Rename
  • Allows users to Rename a current playlist. (Must be in the playlist tab to rename.)
  • Launches a prompt box to allow the user to revise the name of a playlist.
XLNC Rename Playlist Pic

Delete
  • Allows users to remove a selected playlist. (Must be in the playlist tab to delete.)
  • Launches an Alert Box to prompt the user to confirm the deletion.
XLNC Delete Playlist Pic

Refresh
  • Allows the user to refresh the default show folder location without requiring the user to close (Quit) and reopen the program.
  • NOTE: Any of the media files or sequences removed from the default Show Directory and are added to a playlist, they will be removed from the playlist. An Alert pop up box will alert the user of the deleted file from the show directory.
XLNC Refresh Playlist Pic

XLNC Before Refresh Pic XLNC Refresh with File Removed Pic
Confirmation Pop Up Box Example of Backup Folder and Location

Custom Script
XLNC Custom Script Pic
  • Allows users to create custom scripts for interactive displays or projectors.
  • The Prompt pop up box provides a starting point to create the script by setting up various available playback options for a playlist. More information about scripts are located in the Playlist Tab section.

Export Menu

Utilities Menu

Settings Menu

Disable Threaded Save
  • Provides the user with the ability to disable the multi-threaded saves.
  • What does this mean?
    • When disable, all is rendered on the main thread. Slower, but maybe safer.
    • There are now four ways to save
      • Normal - threaded
      • Normal + Fast Save - threaded but only rendering the stuff that has changed
      • Threading disabled (settings menu) - all rendering is on the main thread, one column at a time.
      • Threading disabled + fast save - all rendering is on the main thread.
Retrieved from "http://www.nutcracker123.com/wk/index.php?title=Interface&oldid=155"