Update docs

holoviz · Sep 17, 2020 · 7706d05 · 7706d05
1 parent 9625e46
commit 7706d05
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 7 deletions.
diff --git a/examples/reference/templates/Bootstrap.ipynb b/examples/reference/templates/Bootstrap.ipynb
@@ -17,16 +17,27 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "For a large variety of use cases we do not need complete control over the exact layout of each individual component on the page we just want to achieve a more polished look and feel. For these cases Panel ships with a number of default templates, which are defined by declaring three main content areas on the page, which can be populated as desired:\n",
+    "For a large variety of use cases we do not need complete control over the exact layout of each individual component on the page, as could be achieved with a [custom template](../../user_guide/Templates.ipynb), we just want to achieve a more polished look and feel. For these cases Panel ships with a number of default templates, which are defined by declaring three main content areas on the page, which can be populated as desired:\n",
     "\n",
     "* **`header`**: The header area of the HTML page\n",
     "* **`sidebar`**: A collapsible sidebar\n",
     "* **`main`**: The main area of the application\n",
+    "* **`modal`**: A modal area which can be opened and closed from Python\n",
     "\n",
     "These three areas behave very similarly to other Panel layout components and have list-like semantics. This means we can easily append new components into these areas. Unlike other layout components however, the contents of the areas is fixed once rendered. If you need a dynamic layout you should therefore insert a regular Panel layout component (e.g. a `Column` or `Row`) and modify it in place once added to one of the content areas. \n",
     "\n",
     "Templates can allow for us to quickly and easily create web apps for displaying our data. Panel comes with a default Template, and includes multiple Templates that extend the default which add some customization for a better display.\n",
     "\n",
+    "#### Parameters:\n",
+    "\n",
+    "In addition to the four different areas we can populate the default templates also provide a few additional parameters:\n",
+    "\n",
+    "* **`busy_indicator`** (BooleanIndicator): Visual indicator of application busy state.\n",
+    "* **`header_background`** (str): Optional header background color override.\n",
+    "* **`header_color`** (str): Optional header text color override.\n",
+    "* **`theme`** (Theme): A Theme class (available in `panel.template.theme`)\n",
+    "* **`title`** (str): A title to show in the header.\n",
+    "\n",
     "________"
    ]
   },
@@ -70,7 +81,7 @@
     "        pn.Card(hv.DynamicMap(cosine), title='Cosine')\n",
     "    )\n",
     ")\n",
-    "bootstrap.servable()"
+    "bootstrap.servable();"
    ]
   },
   {

diff --git a/examples/reference/templates/GoldenLayout.ipynb b/examples/reference/templates/GoldenLayout.ipynb
@@ -17,16 +17,27 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "For a large variety of use cases we do not need complete control over the exact layout of each individual component on the page we just want to achieve a more polished look and feel. For these cases Panel ships with a number of default templates, which are defined by declaring three main content areas on the page, which can be populated as desired:\n",
+    "For a large variety of use cases we do not need complete control over the exact layout of each individual component on the page, as could be achieved with a [custom template](../../user_guide/Templates.ipynb), we just want to achieve a more polished look and feel. For these cases Panel ships with a number of default templates, which are defined by declaring three main content areas on the page, which can be populated as desired:\n",
     "\n",
     "* **`header`**: The header area of the HTML page\n",
     "* **`sidebar`**: A collapsible sidebar\n",
     "* **`main`**: The main area of the application\n",
+    "* **`modal`**: A modal area which can be opened and closed from Python\n",
     "\n",
     "These three areas behave very similarly to other Panel layout components and have list-like semantics. This means we can easily append new components into these areas. Unlike other layout components however, the contents of the areas is fixed once rendered. If you need a dynamic layout you should therefore insert a regular Panel layout component (e.g. a `Column` or `Row`) and modify it in place once added to one of the content areas. \n",
     "\n",
     "Templates can allow for us to quickly and easily create web apps for displaying our data. Panel comes with a default Template, and includes multiple Templates that extend the default which add some customization for a better display.\n",
     "\n",
+    "#### Parameters:\n",
+    "\n",
+    "In addition to the four different areas we can populate the default templates also provide a few additional parameters:\n",
+    "\n",
+    "* **`busy_indicator`** (BooleanIndicator): Visual indicator of application busy state.\n",
+    "* **`header_background`** (str): Optional header background color override.\n",
+    "* **`header_color`** (str): Optional header text color override.\n",
+    "* **`theme`** (Theme): A Theme class (available in `panel.template.theme`)\n",
+    "* **`title`** (str): A title to show in the header.\n",
+    "\n",
     "________"
    ]
   },
@@ -83,7 +94,7 @@
     "    )\n",
     ")\n",
     "\n",
-    "golden.servable()"
+    "golden.servable();"
    ]
   },
   {

diff --git a/examples/reference/templates/Material.ipynb b/examples/reference/templates/Material.ipynb
@@ -17,16 +17,27 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "For a large variety of use cases we do not need complete control over the exact layout of each individual component on the page we just want to achieve a more polished look and feel. For these cases Panel ships with a number of default templates, which are defined by declaring three main content areas on the page, which can be populated as desired:\n",
+    "For a large variety of use cases we do not need complete control over the exact layout of each individual component on the page, as could be achieved with a [custom template](../../user_guide/Templates.ipynb), we just want to achieve a more polished look and feel. For these cases Panel ships with a number of default templates, which are defined by declaring three main content areas on the page, which can be populated as desired:\n",
     "\n",
     "* **`header`**: The header area of the HTML page\n",
     "* **`sidebar`**: A collapsible sidebar\n",
     "* **`main`**: The main area of the application\n",
+    "* **`modal`**: A modal area which can be opened and closed from Python\n",
     "\n",
     "These three areas behave very similarly to other Panel layout components and have list-like semantics. This means we can easily append new components into these areas. Unlike other layout components however, the contents of the areas is fixed once rendered. If you need a dynamic layout you should therefore insert a regular Panel layout component (e.g. a `Column` or `Row`) and modify it in place once added to one of the content areas. \n",
     "\n",
     "Templates can allow for us to quickly and easily create web apps for displaying our data. Panel comes with a default Template, and includes multiple Templates that extend the default which add some customization for a better display.\n",
     "\n",
+    "#### Parameters:\n",
+    "\n",
+    "In addition to the four different areas we can populate the default templates also provide a few additional parameters:\n",
+    "\n",
+    "* **`busy_indicator`** (BooleanIndicator): Visual indicator of application busy state.\n",
+    "* **`header_background`** (str): Optional header background color override.\n",
+    "* **`header_color`** (str): Optional header text color override.\n",
+    "* **`theme`** (Theme): A Theme class (available in `panel.template.theme`)\n",
+    "* **`title`** (str): A title to show in the header.\n",
+    "\n",
     "________"
    ]
   },

diff --git a/examples/reference/templates/Vanilla.ipynb b/examples/reference/templates/Vanilla.ipynb
@@ -17,16 +17,27 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "For a large variety of use cases we do not need complete control over the exact layout of each individual component on the page we just want to achieve a more polished look and feel. For these cases Panel ships with a number of default templates, which are defined by declaring three main content areas on the page, which can be populated as desired:\n",
+    "For a large variety of use cases we do not need complete control over the exact layout of each individual component on the page, as could be achieved with a [custom template](../../user_guide/Templates.ipynb), we just want to achieve a more polished look and feel. For these cases Panel ships with a number of default templates, which are defined by declaring three main content areas on the page, which can be populated as desired:\n",
     "\n",
     "* **`header`**: The header area of the HTML page\n",
     "* **`sidebar`**: A collapsible sidebar\n",
     "* **`main`**: The main area of the application\n",
+    "* **`modal`**: A modal area which can be opened and closed from Python\n",
     "\n",
     "These three areas behave very similarly to other Panel layout components and have list-like semantics. This means we can easily append new components into these areas. Unlike other layout components however, the contents of the areas is fixed once rendered. If you need a dynamic layout you should therefore insert a regular Panel layout component (e.g. a `Column` or `Row`) and modify it in place once added to one of the content areas. \n",
     "\n",
     "Templates can allow for us to quickly and easily create web apps for displaying our data. Panel comes with a default Template, and includes multiple Templates that extend the default which add some customization for a better display.\n",
     "\n",
+    "#### Parameters:\n",
+    "\n",
+    "In addition to the four different areas we can populate the default templates also provide a few additional parameters:\n",
+    "\n",
+    "* **`busy_indicator`** (BooleanIndicator): Visual indicator of application busy state.\n",
+    "* **`header_background`** (str): Optional header background color override.\n",
+    "* **`header_color`** (str): Optional header text color override.\n",
+    "* **`theme`** (Theme): A Theme class (available in `panel.template.theme`)\n",
+    "* **`title`** (str): A title to show in the header.\n",
+    "\n",
     "________"
    ]
   },

diff --git a/panel/template/golden/golden.html b/panel/template/golden/golden.html
@@ -74,7 +74,7 @@
                   model: '{{ embed(root) }}',
                   title: "{{ root_labels[root.name] }}"
                 },
-              }
+              },
               {% endif %}
               {% endfor %}
               {% endfor %}