diff options
| author | Adrian Holovaty <adrian@holovaty.com> | 2005-10-19 01:09:05 +0000 |
|---|---|---|
| committer | Adrian Holovaty <adrian@holovaty.com> | 2005-10-19 01:09:05 +0000 |
| commit | f07e5d4f5df5ca9ca3366d7ecc4b01c490c13198 (patch) | |
| tree | 1b73d89471554d058cb46bc13d17bd3687c638fa /django/contrib/admin/templates/admin_doc | |
| parent | fd3d579179581b1fa460e13115471d58fec0c8f6 (diff) | |
Fixed #627 -- BACKWARDS-INCOMPATIBLE CHANGE. Admin is now an app, not a middleware. See BackwardsIncompatibleChanges for a full list of changes and information on how to update your code.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@948 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'django/contrib/admin/templates/admin_doc')
10 files changed, 355 insertions, 0 deletions
diff --git a/django/contrib/admin/templates/admin_doc/bookmarklets.html b/django/contrib/admin/templates/admin_doc/bookmarklets.html new file mode 100644 index 0000000000..d396ec53b5 --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/bookmarklets.html @@ -0,0 +1,30 @@ +{% extends "admin/base_site" %} + +{% block breadcrumbs %}<div class="breadcrumbs"><a href="../../">Home</a> › <a href="../">Documentation</a> › Bookmarklets</div>{% endblock %} + +{% block title %}Documentation bookmarklets{% endblock %} + +{% block content %} + +<p class="help">To install bookmarklets, drag the link to your bookmarks +toolbar, or right-click the link and add it to your bookmarks. Now you can +select the bookmarklet from any page in the site. Note that some of these +bookmarklets require you to be viewing the site from a computer designated +as "internal" (talk to your system administrator if you aren't sure if +your computer is "internal").</p> + +<div id="content-main"> + <h3><a href="javascript:(function(){if(typeof ActiveXObject!='undefined'){x=new ActiveXObject('Microsoft.XMLHTTP')}else if(typeof XMLHttpRequest!='undefined'){x=new XMLHttpRequest()}else{return;}x.open('HEAD',location.href,false);x.send(null);try{view=x.getResponseHeader('x-view');}catch(e){alert('No view found for this page');return;}if(view=="undefined"){alert("No view found for this page");}document.location='{{ admin_url }}/doc/views/'+view+'/';})()">Documentation for this page</a></h3> + <p>Jumps you from any page to the documentation for the view that generates that page.</p> + + <h3><a href="javascript:(function(){if(typeof ActiveXObject!='undefined'){x=new ActiveXObject('Microsoft.XMLHTTP')}else if(typeof XMLHttpRequest!='undefined'){x=new XMLHttpRequest()}else{return;}x.open('GET',location.href,false);x.send(null);try{type=x.getResponseHeader('x-object-type');id=x.getResponseHeader('x-object-id');}catch(e){type='(none)';id='(none)';}d=document;b=d.body;e=d.createElement('div');e.id='xxxhhh';s=e.style;s.position='absolute';s.left='10px';s.top='10px';s.font='10px monospace';s.border='1px black solid';s.padding='4px';s.backgroundColor='#eee';e.appendChild(d.createTextNode('Type: '+type));e.appendChild(d.createElement('br'));e.appendChild(d.createTextNode('ID: '+id));e.appendChild(d.createElement('br'));l=d.createElement('a');l.href='#';l.onclick=function(){b.removeChild(e);};l.appendChild(d.createTextNode('[close]'));l.style.textDecoration='none';e.appendChild(l);b.appendChild(e);})();">Show object ID</a></h3> + <p>Shows the content-type and unique ID for pages that represent a single object.</p> + + <h3><a href="javascript:(function(){if(typeof ActiveXObject!='undefined'){var x=new ActiveXObject('Microsoft.XMLHTTP')}else if(typeof XMLHttpRequest!='undefined'){var x=new XMLHttpRequest()}else{return;}x.open('GET',location.href,false);x.send(null);try{var type=x.getResponseHeader('x-object-type');var id=x.getResponseHeader('x-object-id');}catch(e){return;}document.location='{{ admun_url }}/'+type.split('.').join('/')+'/'+id+'/';})()">Edit this object (current window)</a></h3> + <p>Jumps to the admin page for pages that represent a single object.</p> + + <h3><a href="javascript:(function(){if(typeof ActiveXObject!='undefined'){var x=new ActiveXObject('Microsoft.XMLHTTP')}else if(typeof XMLHttpRequest!='undefined'){var x=new XMLHttpRequest()}else{return;}x.open('GET',location.href,false);x.send(null);try{var type=x.getResponseHeader('x-object-type');var id=x.getResponseHeader('x-object-id');}catch(e){return;}window.open('{{ admun_url }}/'+type.split('.').join('/')+'/'+id+'/');})()">Edit this object (new window)</a></h3> + <p>As above, but opens the admin page in a new window.</p> +</div> + +{% endblock %} diff --git a/django/contrib/admin/templates/admin_doc/index.html b/django/contrib/admin/templates/admin_doc/index.html new file mode 100644 index 0000000000..77d2a96bf2 --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/index.html @@ -0,0 +1,28 @@ +{% extends "admin/base_site" %}
+
+{% block breadcrumbs %}<div class="breadcrumbs"><a href="../">Home</a> › Documentation</div>{% endblock %}
+
+{% block title %}Documentation{% endblock %}
+
+{% block content %}
+
+<h1>Documentation</h1>
+
+<div id="content-main">
+ <h3><a href="tags/">Tags</a></h3>
+ <p>List of all the template tags and their functions.</p>
+
+ <h3><a href="filters/">Filters</a></h3>
+ <p>Filters are actions which can be applied to variables in a template to alter the output.</p>
+
+ <h3><a href="models/">Models</a></h3>
+ <p>Models are descriptions of all the objects in the system and their associated fields. Each model has a list of fields which can be accessed as template variables.</p>
+
+ <h3><a href="views/">Views</a></h3>
+ <p>Each page on the public site is generated by a view. The view defines which template is used to generate the page and which objects are available to that template.</p>
+
+ <h3><a href="bookmarklets/">Bookmarklets</a></h3>
+ <p>Tools for your browser to quickly access admin functionality.</p>
+</div>
+
+{% endblock %}
diff --git a/django/contrib/admin/templates/admin_doc/missing_docutils.html b/django/contrib/admin/templates/admin_doc/missing_docutils.html new file mode 100644 index 0000000000..40004c41ab --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/missing_docutils.html @@ -0,0 +1,17 @@ +{% extends "admin/base_site" %} + +{% block breadcrumbs %}<div class="breadcrumbs"><a href="../">Home</a> › Documentation</div>{% endblock %} + +{% block title %}Please install docutils{% endblock %} + +{% block content %} + +<h1>Documentation</h1> + +<div id="content-main"> + <h3>The admin documentation system requires Python's <a href="http://docutils.sf.net/">docutils</a> library.</h3> + + <p>Please ask your administrators to install <a href="http://docutils.sf.net/">docutils</a>.</p> +</div> + +{% endblock %} diff --git a/django/contrib/admin/templates/admin_doc/model_detail.html b/django/contrib/admin/templates/admin_doc/model_detail.html new file mode 100644 index 0000000000..d3621b7434 --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/model_detail.html @@ -0,0 +1,46 @@ +{% extends "admin/base_site" %} + +{% block extrahead %} + +{{ block.super }} + +<style type="text/css"> + +.module table { width:100%; } + +</style> + +{% endblock %} + +{% block breadcrumbs %}<div class="breadcrumbs"><a href="../../../">Home</a> › <a href="../../">Documentation</a> › <a href="../">Models</a> › {{ name }}</div>{% endblock %} + +{% block title %}Model: {{ name }}{% endblock %} + +{% block content %} +<div id="content-main"> +<h1>{{ summary }}</h1> + +<div class="module"> +<table class="model"> +<thead> +<tr> + <th>Field</th> + <th>Type</th> + <th>Description</th> +</tr> +</thead> +<tbody> +{% for field in fields|dictsort:"name" %} +<tr> + <td>{{ field.name }}</td> + <td>{{ field.data_type }}</td> + <td>{{ field.verbose|default:"" }}{% if field.help_text %} - {{ field.help_text }}{% endif %}</td> +</tr> +{% endfor %} +</tbody> +</table> +</div> + +<p class="small"><a href="../">‹ Back to Models Documentation</p> +</div> +{% endblock %} diff --git a/django/contrib/admin/templates/admin_doc/model_index.html b/django/contrib/admin/templates/admin_doc/model_index.html new file mode 100644 index 0000000000..5896ee136e --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/model_index.html @@ -0,0 +1,44 @@ +{% extends "admin/base_site" %} + +{% block coltype %}colSM{% endblock %} + +{% block breadcrumbs %}<div class="breadcrumbs"><a href="../../">Home</a> › <a href="../">Documentation</a> › Models</div>{% endblock %} + +{% block title %}Models{% endblock %} + +{% block content %} + +<h1>Models Documentation</h1> + +<div id="content-main"> +{% regroup models|dictsort:"module" by module as grouped_models %} +{% for group in grouped_models %} +<div class="module"> +<h2 id='{{ group.grouper }}'>{{ group.grouper }}</h2> + +<table class="xfull"> +{% for model in group.list %} +<tr> +<th><a href="{{ model.name }}/">{{ model.class }}</a></th> +</tr> +{% endfor %} +</table> +</div> +{% endfor %} + +</div> +{% endblock %} + +{% block sidebar %} +<div id="content-related" class="sidebar"> +<div class="module"> +<h2>Model Groups Quick List</h2> +<ul> +{% regroup models|dictsort:"module" by module as grouped_models %} +{% for group in grouped_models %} + <li><a href="#{{ group.grouper }}">{{ group.grouper }}</a></li> +{% endfor %} +</ul> +</div> +</div> +{% endblock %} diff --git a/django/contrib/admin/templates/admin_doc/template_detail.html b/django/contrib/admin/templates/admin_doc/template_detail.html new file mode 100644 index 0000000000..448ff212ba --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/template_detail.html @@ -0,0 +1,21 @@ +{% extends "admin/base_site" %} + +{% block breadcrumbs %}<div class="breadcrumbs"><a href="../../../">Home</a> › <a href="../../">Documentation</a> › Templates › {{ name }}</div>{% endblock %} + +{% block title %}Template: {{ name }}{% endblock %} + +{% block content %} +<h1>Template: "{{ name }}"</h1> + +{% regroup templates|dictsort:"site_id" by site as templates_by_site %} +{% for group in templates_by_site %} + <h2>Search path for template "{{ name }}" on {{ group.grouper }}:</h2> + <ol> + {% for template in group.list|dictsort:"order" %} + <li><code>{{ template.file }}</code>{% if not template.exists %} <em>(does not exist)</em>{% endif %}</li> + {% endfor %} + </ol> +{% endfor %} + +<p class="small"><a href="../../">‹ Back to Documentation</a></p> +{% endblock %} diff --git a/django/contrib/admin/templates/admin_doc/template_filter_index.html b/django/contrib/admin/templates/admin_doc/template_filter_index.html new file mode 100644 index 0000000000..23f0862457 --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/template_filter_index.html @@ -0,0 +1,50 @@ +{% extends "admin/base_site" %} + +{% block coltype %}colSM{% endblock %} + +{% block breadcrumbs %}<div class="breadcrumbs"><a href="../../">Home</a> › <a href="../">Documentation</a> › filters</div>{% endblock %} + +{% block title %}Template filters{% endblock %} + +{% block content %} + +<h1>Template filter documentation</h1> + +<div id="content-main"> +{% regroup filters|dictsort:"library" by library as filter_libraries %} +{% for library in filter_libraries %} +<div class="module"> + <h2>{% if library.grouper %}{{ library.grouper }}{% else %}Built-in filters{% endif %}</h2> + {% if library.grouper %}<p class="small quiet">To use these filters, put <code>{% templatetag openblock %} load {{ library.grouper }} {% templatetag closeblock %}</code> in your template before using the filter.</p><hr>{% endif %} + {% for filter in library.list|dictsort:"name" %} + <h3 id="{{ filter.name }}">{{ filter.name }}</h3> + <p>{{ filter.title }}</p> + <p><strong>Usage:</strong> <code>{% templatetag openvariable %} variable|{{ filter.name }}{% if filter.meta.AcceptsArgument %}:"arg"{% endif %} {% templatetag closevariable %}</code></p> + <p>{{ filter.body }}</p> + {% if not forloop.last %}<hr />{% endif %} + {% endfor %} +</div> +{% endfor %} +</div> + +{% endblock %} + +{% block sidebar %} + +<div id="content-related"> + +{% regroup filters|dictsort:"library" by library as filter_libraries %} +{% for library in filter_libraries %} +<div class="module"> + <h2>{% if library.grouper %}{{ library.grouper }}{% else %}Built-in filters{% endif %}</h2> + <ul> + {% for filter in library.list|dictsort:"name" %} + <li><a href="#{{ filter.name }}">{{ filter.name }}</a></li> + {% endfor %} + </ul> +</div> +{% endfor %} + +</div> + +{% endblock %} diff --git a/django/contrib/admin/templates/admin_doc/template_tag_index.html b/django/contrib/admin/templates/admin_doc/template_tag_index.html new file mode 100644 index 0000000000..83b2572322 --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/template_tag_index.html @@ -0,0 +1,49 @@ +{% extends "admin/base_site" %} + +{% block coltype %}colSM{% endblock %} + +{% block breadcrumbs %}<div class="breadcrumbs"><a href="../../">Home</a> › <a href="../">Documentation</a> › Tags</div>{% endblock %} + +{% block title %}Template tags{% endblock %} + +{% block content %} + +<h1>Template tag documentation</h1> + +<div id="content-main"> +{% regroup tags|dictsort:"library" by library as tag_libraries %} +{% for library in tag_libraries %} +<div class="module"> + <h2>{% if library.grouper %}{{ library.grouper }}{% else %}Built-in tags{% endif %}</h2> + {% if library.grouper %}<p class="small quiet">To use these tags, put <code>{% templatetag openblock %} load {{ library.grouper }} {% templatetag closeblock %}</code> in your template before using the tag.</p><hr>{% endif %} + {% for tag in library.list|dictsort:"name" %} + <h3 id="{{ tag.name }}">{{ tag.name }}</h3> + <h4>{{ tag.title }}</h4> + <p>{{ tag.body }}</p> + {% if not forloop.last %}<hr />{% endif %} + {% endfor %} +</div> +{% endfor %} +</div> + +{% endblock %} + +{% block sidebar %} + +<div id="content-related"> + +{% regroup tags|dictsort:"library" by library as tag_libraries %} +{% for library in tag_libraries %} +<div class="module"> + <h2>{% if library.grouper %}{{ library.grouper }}{% else %}Built-in tags{% endif %}</h2> + <ul> + {% for tag in library.list|dictsort:"name" %} + <li><a href="#{{ tag.name }}">{{ tag.name }}</a></li> + {% endfor %} + </ul> +</div> +{% endfor %} + +</div> + +{% endblock %} diff --git a/django/contrib/admin/templates/admin_doc/view_detail.html b/django/contrib/admin/templates/admin_doc/view_detail.html new file mode 100644 index 0000000000..9fb06e7eb7 --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/view_detail.html @@ -0,0 +1,26 @@ +{% extends "admin/base_site" %} + +{% block breadcrumbs %}<div class="breadcrumbs"><a href="../../../">Home</a> › <a href="../../">Documentation</a> › <a href="../">Views</a> › {{ name }}</div>{% endblock %} + +{% block title %}View: {{ name }}{% endblock %} + +{% block content %} + +<h1>{{ name }}</h1> + +<h2 class="subhead">{{ summary }}</h2> + +<p>{{ body }}</p> + +{% if meta.Context %} +<h3>Context:</h3> +<p>{{ meta.Context }}</p> +{% endif %} + +{% if meta.Templates %} +<h3>Templates:</h3> +<p>{{ meta.Templates }}</p> +{% endif %} + +<p class="small"><a href="../">‹ Back to Views Documentation</a></p> +{% endblock %} diff --git a/django/contrib/admin/templates/admin_doc/view_index.html b/django/contrib/admin/templates/admin_doc/view_index.html new file mode 100644 index 0000000000..90ef5b1c90 --- /dev/null +++ b/django/contrib/admin/templates/admin_doc/view_index.html @@ -0,0 +1,44 @@ +{% extends "admin/base_site" %}
+
+{% block coltype %}colSM{% endblock %}
+
+{% block breadcrumbs %}<div class="breadcrumbs"><a href="../../">Home</a> › <a href="../">Documentation</a> › Views</div>{% endblock %}
+
+{% block title %}Views{% endblock %}
+
+{% block content %}
+
+<h1>View documentation</h1>
+
+{% regroup views|dictsort:"site_id" by site as views_by_site %}
+
+<div id="content-related" class="sidebar">
+<div class="module">
+<h2>Jump to site</h2>
+<ul>
+ {% for site_views in views_by_site %}
+ <li><a href="#site{{ site_views.grouper.id }}">{{ site_views.grouper.name }}</a></li>
+ {% endfor %}
+</ul>
+</div>
+</div>
+
+<div id="content-main">
+
+{% for site_views in views_by_site %}
+<div class="module">
+<h2 id="site{{ site_views.grouper.id }}">Views by URL on {{ site_views.grouper.name }}</h2>
+
+{% for view in site_views.list|dictsort:"url" %}
+{% ifchanged %}
+<h3><a href="{{ view.module }}.{{ view.name }}/"/>{{ view.url|escape }}</a></h3>
+<p class="small quiet">View function: {{ view.module }}.{{ view.name }}</p>
+<p>{{ view.title }}</p>
+<hr>
+{% endifchanged %}
+{% endfor %}
+</div>
+{% endfor %}
+</div>
+{% endblock %}
+
|
