Browse Source

Format doc for user readability

Carol Willing 8 years ago
parent
commit
a536c84a04
1 changed files with 53 additions and 41 deletions
  1. 53 41
      tutorial/documents.md

+ 53 - 41
tutorial/documents.md

@@ -21,9 +21,52 @@ uses the Document Manager when creating and opening files.
 The [Document Registry](http://jupyter.org/jupyterlab/classes/_docregistry_registry_.documentregistry.html)
 is the default mechanism for interacting with files in JupyterLab.
 
+## Document Registry
+
+*Document widget extensions* in the JupyterLab application can register:
+
+- widget factories
+- model factories
+- widget extensions
+- file types
+- file creators
+
+### [Widget Factories](http://jupyter.org/jupyterlab/classes/_docregistry_registry_.documentregistry.html#registerwidgetfactory)
+
+Create a widget for a given file.
+
+*Example*
+- The notebook widget factory that creates NotebookPanel widgets.
+
+### [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](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.
+
+*Examples*
+- The ipywidgets extension that is created for NotebookPanel widgets.
+- Adding a button to the toolbar of each NotebookPanel widget.
+
+### [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](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 Manager
 
-The Document Manager handles:
+The *Document Manager* handles:
 
 - models
 - contexts
@@ -39,9 +82,12 @@ extensions.
 ### [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
+widget extensions.
+
+They are used to provide an abstracted interface
 to the session and contents API from jupyter-js-services for the
 given model.  They are tied to a model and can be shared between widgets.
+
 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.
@@ -49,43 +95,9 @@ Manager.
 ### [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
-factory are created asynchronously after potentially loading data
-from disk.  Some interfaces (like drag and drop) require a widget to be
-returned synchronously.
-
-## Registry
-
-Extensions in the JupyterLab application can register:
-
-- widget factories
-- model factories
-- widget extensions
-- file types
-- file creators
-
-### [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](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](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](http://jupyter.org/jupyterlab/classes/_docregistry_registry_.documentregistry.html#registerfiletype)
-Intended to be used in a "Create New" dialog, providing a list of known
+returned by the widget factory.
 
-## [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 wrappers are used because they can be created synchronously; while,
+the widgets created using the widget factory are created asynchronously after
+potentially loading data from disk. Some interfaces (like drag and drop)
+require a widget to be returned synchronously.