PrivateNotebookOptions

PrivateNotebookOptions

is an option for notebooks that specifies various low-level notebook settings.

Details

  • The typical usage is PrivateNotebookOptions->{opt1->val1,opt2->val2,…}.
  • The following suboptions can be specified:
  • "DoubleBuffer"Truewhether double buffering, a method of reducing flicker while a notebook is being edited, is used for a notebook
    "ExcludeFromShutdown"Falseon platforms with menu bars integrated into the notebook windows, whether closing this notebook might trigger the Wolfram System to quit if it is the last such notebook
    "FileContents"{"FileLeader","StandardFileLeader","NotebookData","StandardFileTrailer","FileTrailer"}the components that should be saved out to a notebook file, and their ordering
    "FileLeader"""a string holding a customized file header that should be attached to saved notebook files
    "FileOutlineCache"Automaticwhether to include a file outline cache when saving notebook files
    "FileTrailer"""a string holding a customized file footer that should be attached to saved notebook files
    "FinalWindowPrompt"Falseon systems with menu bars integrated into notebook windows, whether the closing of the last notebook window should prompt to exit
    "SafeFileOpen"Nonewhether the Wolfram System should take any special precautions before opening a notebook
    "SafeFileSave""Prescan"whether the Wolfram System should take any special precautions before saving the notebook
  • With the default setting "DoubleBuffer"->True, two copies of the rendered notebook are stored in memory at all times. While the screen display of the notebook is being updated, the backup copy is displayed on the screen, reducing the flicker caused by the editing changes.
  • With the setting "SafeFileOpen""IgnoreCache", the Wolfram System ignores the file outline cache when opening a notebook. The file outline cache contains information about the structure of the notebook and reduces the time taken to open large notebooks. With the "IgnoreCache" setting, you can open a notebook even if its file outline cache has become corrupted. This setting has the same effect as the Parse and Load Entire Notebook into Memory before Opening option of the Notebook Options dialog.
  • With the setting "SafeFileOpen""Prescan", the Wolfram System scans the expression for each cell in the notebook to confirm that it starts with the text Cell[. This is a quick way to check for one common sign of file corruption.
  • With the setting "SafeFileOpen"->None, the Wolfram System does not take any special precautions before opening a notebook. Use this setting if you want to minimize the time taken to open a notebook.
  • With the default setting "SafeFileSave""Prescan", the Wolfram System estimates the number of bytes in the notebook and checks if adequate disk space is available before saving it. If there is not enough disk space, a message is displayed.
  • With the setting "SafeFileSave""TempFile", the Wolfram System creates and saves a separate copy of the file instead of overwriting the existing copy. This ensures that if you run out of disk space, the last saved version of the file is still available. Once the new copy is successfully saved, the previous copy is deleted.
  • The "TempFile" setting is relevant for multiple-user platforms like Unix and Windows 2000. On such platforms, a file save operation may fail even with adequate disk space on the machine if the user’s disk quota is exceeded.
  • With the setting "SafeFileSave"->None, the Wolfram System does not take any special precautions before saving a notebook. Use this setting if you are sure you have adequate disk space for your files.

Examples

Basic Examples  (1)

Create a notebook that will save with no file outline cache and bare-bones contents:

Save the notebook:

Confirm the contents have no cache or decorations:

Clean up:

Wolfram Research (1999), PrivateNotebookOptions, Wolfram Language function, https://reference.wolfram.com/language/ref/PrivateNotebookOptions.html (updated 2014).

Text

Wolfram Research (1999), PrivateNotebookOptions, Wolfram Language function, https://reference.wolfram.com/language/ref/PrivateNotebookOptions.html (updated 2014).

CMS

Wolfram Language. 1999. "PrivateNotebookOptions." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2014. https://reference.wolfram.com/language/ref/PrivateNotebookOptions.html.

APA

Wolfram Language. (1999). PrivateNotebookOptions. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/PrivateNotebookOptions.html

BibTeX

@misc{reference.wolfram_2023_privatenotebookoptions, author="Wolfram Research", title="{PrivateNotebookOptions}", year="2014", howpublished="\url{https://reference.wolfram.com/language/ref/PrivateNotebookOptions.html}", note=[Accessed: 19-April-2024 ]}

BibLaTeX

@online{reference.wolfram_2023_privatenotebookoptions, organization={Wolfram Research}, title={PrivateNotebookOptions}, year={2014}, url={https://reference.wolfram.com/language/ref/PrivateNotebookOptions.html}, note=[Accessed: 19-April-2024 ]}