From ce0d0cd9e2cd5ac9850d825f28db39b1e123ac1e Mon Sep 17 00:00:00 2001 From: Jacob Kaplan-Moss Date: Tue, 2 Aug 2005 19:59:51 +0000 Subject: [PATCH] Made a bunch of fixes to auto-generated admin documentation: * Views are no longer "doubled" * Links work better (view -> model links and friends were broken) * Performance has been improved so now the pages no longer need to be cached. git-svn-id: http://code.djangoproject.com/svn/django/trunk@391 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- django/conf/admin_media/css/global.css | 2 ++ django/conf/admin_templates/doc/index.html | 3 -- .../conf/admin_templates/doc/view_index.html | 34 +++++++++--------- django/core/defaulttags.py | 10 +++--- django/parts/admin/doc.py | 35 ++++++++++--------- django/templatetags/log.py | 14 +++++--- django/views/admin/doc.py | 12 ++----- 7 files changed, 55 insertions(+), 55 deletions(-) diff --git a/django/conf/admin_media/css/global.css b/django/conf/admin_media/css/global.css index 57f650918d722..90666791561bf 100644 --- a/django/conf/admin_media/css/global.css +++ b/django/conf/admin_media/css/global.css @@ -67,6 +67,8 @@ code, pre { font-family:"Bitstream Vera Sans Mono", Monaco, "Courier New", Couri pre.literal-block { margin:10px; background:#eee; padding:6px 8px; } code strong { color:#930; } hr { clear:both; color:#eee; background-color:#eee; height:1px; border:none; margin:0; padding:0; font-size:1px; line-height:1px; } +div.system-message { background: #ffc; margin: 10px; padding: 6px 8px; font-size: .8em; } +div.system-message p.system-message-title { padding:4px 5px 4px 25px; margin:0; color:red;background:#ffc url(../img/admin/icon_error.gif) 5px .3em no-repeat; } /* PAGE STRUCTURE */ diff --git a/django/conf/admin_templates/doc/index.html b/django/conf/admin_templates/doc/index.html index e3da0ccf9b10d..e205d0a486bc8 100644 --- a/django/conf/admin_templates/doc/index.html +++ b/django/conf/admin_templates/doc/index.html @@ -21,9 +21,6 @@

Models

Views

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.

-

Views

-

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.

-

Bookmarklets

Tools for your browser to quickly access admin functionality.

diff --git a/django/conf/admin_templates/doc/view_index.html b/django/conf/admin_templates/doc/view_index.html index 60b4b81320ad5..c14b1f07ac4d5 100644 --- a/django/conf/admin_templates/doc/view_index.html +++ b/django/conf/admin_templates/doc/view_index.html @@ -10,37 +10,35 @@

View documentation

+{% regroup views|dictsort:"site_id" by site as views_by_site %} + +
+
+

Jump to site

+ +
+
+
-{% regroup views|dictsort:"site_id" by site as views_by_site %} {% for site_views in views_by_site %}

Views by URL on {{ site_views.grouper.name }}

{% for view in site_views.list|dictsort:"url" %} +{% ifchanged %}

{{ view.url|escape }}

-

({{ view.module }}.{{ view.name }})

+

View function: {{ view.module }}.{{ view.name }}

{{ view.title }}

+{% endifchanged %} {% endfor %} -
{% endfor %} -
- {% endblock %} -{% block sidebar %} -
-
-

Jump to site

-
    - {% regroup views|dictsort:"site_id" by site as views_by_site %} - {% for site_views in views_by_site %} -
  • {{ site_views.grouper.name }}
    • - {% endfor %} -
-
-
-{% endblock %} diff --git a/django/core/defaulttags.py b/django/core/defaulttags.py index e5620f7743a88..cc449a8338d19 100644 --- a/django/core/defaulttags.py +++ b/django/core/defaulttags.py @@ -470,7 +470,9 @@ def do_if(parser, token): """ The ``{% if %}`` tag evaluates a variable, and if that variable is "true" (i.e. exists, is not empty, and is not a false boolean value) the contents - of the block are output:: + of the block are output: + + :: {% if althlete_list %} Number of athletes: {{ althete_list|count }} @@ -481,7 +483,7 @@ def do_if(parser, token): In the above, if ``athlete_list`` is not empty, the number of athletes will be displayed by the ``{{ athlete_list|count }}`` variable. - As you can see, the ``if`` tag can take an option ``{% else %} clause that + As you can see, the ``if`` tag can take an option ``{% else %}`` clause that will be displayed if the test fails. ``if`` tags may use ``or`` or ``not`` to test a number of variables or to @@ -501,8 +503,8 @@ def do_if(parser, token): stupid; it's not my fault). {% endif %} - For simplicity, ``if`` tags do not allow ``and`` clauses; use nested ``if``s - instead:: + For simplicity, ``if`` tags do not allow ``and`` clauses; use nested ``if`` + tags instead:: {% if athlete_list %} {% if coach_list %} diff --git a/django/parts/admin/doc.py b/django/parts/admin/doc.py index b94f45b1989eb..f102278d76018 100644 --- a/django/parts/admin/doc.py +++ b/django/parts/admin/doc.py @@ -8,18 +8,7 @@ import docutils.core import docutils.nodes import docutils.parsers.rst.roles - -# -# reST roles -# -ROLES = { - # role name, base role url (in the admin) - 'model' : '/doc/models/%s/', - 'view' : '/doc/views/%s/', - 'template' : '/doc/templates/%s/', - 'filter' : '/doc/filters/#%s', - 'tag' : '/doc/tags/#%s', -} +from urlparse import urljoin def trim_docstring(docstring): """ @@ -60,31 +49,43 @@ def parse_docstring(docstring): body = "\n\n".join(parts[1:]) return title, body, metadata -def parse_rst(text, default_reference_context, thing_being_parsed=None): +def parse_rst(text, default_reference_context, thing_being_parsed=None, link_base='../..'): """ Convert the string from reST to an XHTML fragment. """ overrides = { - 'input_encoding' : 'unicode', 'doctitle_xform' : True, 'inital_header_level' : 3, + "default_reference_context" : default_reference_context, + "link_base" : link_base, } if thing_being_parsed: thing_being_parsed = "<%s>" % thing_being_parsed parts = docutils.core.publish_parts(text, source_path=thing_being_parsed, destination_path=None, writer_name='html', - settings_overrides={'default_reference_context' : default_reference_context}) + settings_overrides=overrides) return parts['fragment'] +# +# reST roles +# +ROLES = { + 'model' : '%s/models/%s/', + 'view' : '%s/views/%s/', + 'template' : '%s/templates/%s/', + 'filter' : '%s/filters/#%s', + 'tag' : '%s/tags/#%s', +} + def create_reference_role(rolename, urlbase): def _role(name, rawtext, text, lineno, inliner, options={}, content=[]): - node = docutils.nodes.reference(rawtext, text, refuri=(urlbase % text), **options) + node = docutils.nodes.reference(rawtext, text, refuri=(urlbase % (inliner.document.settings.link_base, text)), **options) return [node], [] docutils.parsers.rst.roles.register_canonical_role(rolename, _role) def default_reference_role(name, rawtext, text, lineno, inliner, options={}, content=[]): context = inliner.document.settings.default_reference_context - node = docutils.nodes.reference(rawtext, text, refuri=(ROLES[context] % text), **options) + node = docutils.nodes.reference(rawtext, text, refuri=(ROLES[context] % (inliner.document.settings.link_base, text)), **options) return [node], [] docutils.parsers.rst.roles.register_canonical_role('cmsreference', default_reference_role) docutils.parsers.rst.roles.DEFAULT_INTERPRETED_ROLE = 'cmsreference' diff --git a/django/templatetags/log.py b/django/templatetags/log.py index 3f858fa1f8533..564d8fbfa0e18 100644 --- a/django/templatetags/log.py +++ b/django/templatetags/log.py @@ -17,14 +17,20 @@ def render(self, context): class DoGetAdminLog: """ Populates a template variable with the admin log for the given criteria. - Usage: + + Usage:: + {% get_admin_log [limit] as [varname] for_user [context_var_containing_user_obj] %} - Examples: + + Examples:: + {% get_admin_log 10 as admin_log for_user 23 %} {% get_admin_log 10 as admin_log for_user user %} {% get_admin_log 10 as admin_log %} - Note that [context_var_containing_user_obj] can be a hard-coded integer (user ID) or the - name of a template context variable containing the user object whose ID you want. + + Note that ``context_var_containing_user_obj`` can be a hard-coded integer + (user ID) or the name of a template context variable containing the user + object whose ID you want. """ def __init__(self, tag_name): self.tag_name = tag_name diff --git a/django/views/admin/doc.py b/django/views/admin/doc.py index 8395ebc740e6c..99250333b8dd3 100644 --- a/django/views/admin/doc.py +++ b/django/views/admin/doc.py @@ -2,7 +2,6 @@ from django import templatetags from django.conf import settings from django.models.core import sites -from django.views.decorators.cache import cache_page from django.core.extensions import DjangoContext as Context from django.core.exceptions import Http404, ViewDoesNotExist from django.utils.httpwrappers import HttpResponse, HttpResponseRedirect @@ -32,6 +31,8 @@ def bookmarklets(request): return HttpResponse(t.render(c)) def template_tag_index(request): + import sys + if not doc: return missing_docutils_page(request) @@ -69,7 +70,6 @@ def template_tag_index(request): 'tags' : tags, }) return HttpResponse(t.render(c)) -template_tag_index = cache_page(template_tag_index, 15*60) def template_filter_index(request): if not doc: @@ -106,7 +106,6 @@ def template_filter_index(request): 'filters' : filters, }) return HttpResponse(t.render(c)) -template_filter_index = cache_page(template_filter_index, 15*60) def view_index(request): if not doc: @@ -118,13 +117,9 @@ def view_index(request): urlconf = __import__(settings_mod.ROOT_URLCONF, '', '', ['']) view_functions = extract_views_from_urlpatterns(urlconf.urlpatterns) for (func, regex) in view_functions: - title, body, metadata = doc.parse_docstring(func.__doc__) - if title: - title = doc.parse_rst(title, 'view', 'view:' + func.__name__) views.append({ 'name' : func.__name__, 'module' : func.__module__, - 'title' : title, 'site_id': settings_mod.SITE_ID, 'site' : sites.get_object(pk=settings_mod.SITE_ID), 'url' : simplify_regex(regex), @@ -134,7 +129,6 @@ def view_index(request): 'views' : views, }) return HttpResponse(t.render(c)) -view_index = cache_page(view_index, 15*60) def view_detail(request, view): if not doc: @@ -151,7 +145,7 @@ def view_detail(request, view): if body: body = doc.parse_rst(body, 'view', 'view:' + view) for key in metadata: - metadata[key] = doc.parse_rst(metadata[key], 'view', 'view:' + view) + metadata[key] = doc.parse_rst(metadata[key], 'model', 'view:' + view) t = template_loader.get_template('doc/view_detail') c = Context(request, { 'name' : view,