BS5 Theme

docs/development/custom/url-hooks.md

@@ -12,6 +12,18 @@ def register_urls():
     return UrlHook(app_name.urls, 'app_name', r^'app_name/')
 ```
 
+#### urls
+
+The urls module to include. See [the Django docs](https://docs.djangoproject.com/en/dev/topics/http/urls/#example) for designing urlpatterns.
+
+#### namespace
+
+The URL namespace to apply. This is usually just the app name.
+
+#### base_url
+
+The URL prefix to match against in regex form. Example `r'^app_name/'`. This prefix will be applied in front of all URL patterns included. It is possible to use the same prefix as existing apps (or no prefix at all) but [standard URL resolution](https://docs.djangoproject.com/en/dev/topics/http/urls/#how-django-processes-a-request) ordering applies (hook URLs are the last ones registered).
+
 ### Public views
 
 In addition is it possible to make views public. Normally, all views are automatically decorated with the `main_character_required` decorator. That decorator ensures a user needs to be logged in and have a main before he can access that view. This feature protects against a community app sneaking in a public view without the administrator knowing about it.
@@ -22,7 +34,6 @@ An app can opt-out of this feature by adding a list of views to be excluded when
 .. note::
     Note that for a public view to work, administrators need to also explicitly allow apps to have public views in their AA installation, by adding the apps label to ``APPS_WITH_PUBLIC_VIEWS`` setting.
 ```
-
 ## Examples
 
 An app called `plugin` provides a single view: