|
|
@@ -1,7 +1,7 @@
|
|
|
# Documents
|
|
|
-The Document Registry is the default mechanism for interacting with
|
|
|
-files in JupyterLab. The Document Manager uses it to create models and
|
|
|
-widgets for documents. The File Browser uses the Document Manager when
|
|
|
+The [Document Registry](http://jupyter.org/jupyterlab/classes/_docregistry_registry_.documentregistry.html) is the default mechanism for interacting with
|
|
|
+files in JupyterLab. The [Document Manager](http://jupyter.org/jupyterlab/classes/_docmanager_manager_.documentmanager.html) uses it to create models and
|
|
|
+widgets for documents. The [File Browser](http://jupyter.org/jupyterlab/classes/_filebrowser_browser_.filebrowserwidget.html) uses the Document Manager when
|
|
|
creating and opening files.
|
|
|
|
|
|
The Document Manager handles models, contexts, and widgets for documents
|
|
|
@@ -10,34 +10,34 @@ and manages their life cycle.
|
|
|
Extensions in the JupyterLab application can register widget factories,
|
|
|
model factories, widget extensions, file types, and file creators.
|
|
|
|
|
|
-## Widget Factories
|
|
|
+## [Widget Factories](http://jupyter.org/jupyterlab/classes/_docregistry_registry_.documentregistry.html#registerwidgetfactory)
|
|
|
Create a widget for a given file. An example is the notebook widget
|
|
|
factory that creates NotebookPanel widgets.
|
|
|
|
|
|
-## Model Factories
|
|
|
+## [Model Factories](http://jupyter.org/jupyterlab/classes/_docregistry_registry_.documentregistry.html#registermodelfactory)
|
|
|
Create a model for a given file. Models are generally differentiated by
|
|
|
the contents options used to fetch the model (e.g. text, base64, notebook).
|
|
|
|
|
|
-## Widget Extensions
|
|
|
+## [Widget Extensions](http://jupyter.org/jupyterlab/classes/_docregistry_registry_.documentregistry.html#registerextension)
|
|
|
Add additional functionality to a widget type. An extension instance is
|
|
|
created for each widget instance. An example is the ipywidgets extension
|
|
|
that is created for NotebookPanel widgets. Another example would be to add a
|
|
|
button to the toolbar of each NotebookPanel widget.
|
|
|
|
|
|
-## File Types
|
|
|
+## [File Types](http://jupyter.org/jupyterlab/classes/_docregistry_registry_.documentregistry.html#registerfiletype)
|
|
|
Intended to be used in a "Create New" dialog, providing a list of known
|
|
|
file types.
|
|
|
|
|
|
-## File Creators
|
|
|
+## [File Creators](http://jupyter.org/jupyterlab/classes/_docregistry_registry_.documentregistry.html#registercreator)
|
|
|
Intended for create quick launch file creators. The default use will be for
|
|
|
the "create new" dropdown in the file browser, giving list of items that can
|
|
|
be created with default options (e.g. "Python 3 Notebook").
|
|
|
|
|
|
-## Document Models
|
|
|
+## [Document Models](http://jupyter.org/jupyterlab/interfaces/_docregistry_interfaces_.idocumentmodel.html)
|
|
|
Created by the model factories and passed to widget factories and widget
|
|
|
extensions.
|
|
|
|
|
|
-## Document Contexts
|
|
|
+## [Document Contexts](http://jupyter.org/jupyterlab/interfaces/_docregistry_interfaces_.idocumentcontext.html)
|
|
|
Created by the Document Manager and passed to widget factories and
|
|
|
widget extensions. They are used to provide an abstracted interface
|
|
|
to the session and contents API from jupyter-js-services for the
|
|
|
@@ -46,7 +46,7 @@ The reason for a separate context and model is so that it is easy to create
|
|
|
model factories and the heavy lifting of the context is left to the Document
|
|
|
Manager.
|
|
|
|
|
|
-## Document Wrappers
|
|
|
+## [Document Wrappers](http://jupyter.org/jupyterlab/classes/_docmanager_manager_.documentwrapper.html)
|
|
|
The top level widget created by the Document Manager that wraps the widget
|
|
|
returned by the widget factory. They are used because they can be
|
|
|
created synchronously, while the widgets created using the widget
|
Steven Silvester