Skip to content

D
django-wiki
Commit d1ea57b1 by Luke Plant
Options

Added easy way to brand the wiki, avoiding lots of copy and paste. 

Includes docs.
parent 3b7420ec
Showing with 177 additions and 132 deletions
docs/customization.rst 0 → 100644
Customization
=============
See :doc:`settings` for the settings that can be used to configure
django-wiki. Other ways to customize django-wiki for your use are listed below.
Templates
---------
django-wiki can be customized by providing your own templates.
All templates used by django-wiki inherit from ``wiki/base_site.html``, which in
turn simply inherits from ``wiki/base.html`` (adding
nothing). ``wiki/base.html`` provides a complete HTML page, but provides a
number of blocks that you might want to override. The most useful are:
* ``wiki_header_branding``
* ``wiki_header_navlinks``
These can be overridden to provide your own branding and links in the top bar of
the page. The ``wiki/base_site.html`` template uses Bootstrap 3, so the
following example shows how to use this in practice, assuming you want a single
link to your home page, and one to the wiki:
.. code-block:: html+django
{% extends "wiki/base_site.html" %}
{% block wiki_header_branding %}
<a class="navbar-brand" href="/">Your brand</a>
{% endblock %}
{% block wiki_header_navlinks %}
<ul class="nav navbar-nav">
<li class="active"><a href="{% url 'wiki:root' %}">Wiki</a></li>
</ul>
{% endblock %}
docs/index.rst
...@@ -13,6 +13,7 @@ Contents: ...@@ -13,6 +13,7 @@ Contents:
installation installation
plugins plugins
customization
settings settings
tips tips
......
wiki/templates/wiki/base.html
{% load sekizai_tags i18n wiki_tags %}{% load url from future %}<!DOCTYPE html> {% extends "wiki/base_site.html" %}
<html lang="en">
<head>
<meta charset="utf-8">
<title>{% block wiki_pagetitle %}{% endblock %} - django-\/\/ i K |</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="description" content="">
<meta name="author" content="www.django-wiki.org">
<!-- Le styles -->
<link href="{{ STATIC_URL }}wiki/bootstrap/css/wiki-bootstrap.min.css" rel="stylesheet">
{% render_block "css" %}
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
{% block wiki_body %}
{% block wiki_navbar %}
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="container">
<!-- .navbar-toggle is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-responsive-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
{% block wiki_header_branding %}
<a class="navbar-brand" href="{% url 'wiki:root' %}">django-\/\/ i K |</a>
{% endblock %}
<div class="nav-collapse collapse navbar-responsive-collapse">
<form class="navbar-form pull-right-block-on-responsive" id="wiki-search-form" method="GET" action="{% url 'wiki:search' %}">
<div class="input-group">
<input type="search" class="form-control search-query" name="q" placeholder="{% trans "Search..." %}" />
<span class="input-group-btn">
<button class="btn btn-default" type="button">
<span class="icon-search"></span>
</button>
</span>
</div><!-- /input-group -->
</form>
<div class="pull-right-block-on-responsive">
{% if user.is_authenticated %}
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<span class="badge notification-cnt">0</span>
{{ user }}
<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="{% url 'wiki:logout' %}">
<i class="icon-off"></i>
{% trans "Log out" %}
</a>
</li>
{% include "wiki/plugins/notifications/menubaritem.html" %}
</ul>
</li>
</ul>
{% else %}
<ul class="nav navbar-nav">
<li>
<a href="{% login_url as wiki_login_url %}{{ wiki_login_url }}">{% trans "Log in" %}</a>
</li>
<li>
<a href="{% url 'wiki:signup' %}">{% trans "Sign up" %}</a>
</li>
</ul>
{% endif %}
</div>
<ul class="nav navbar-nav">
<li class="active"><a href="/">{% trans "Home" %}</a></li>
<li><a href="https://github.com/benjaoming/django-wiki" target="_blank">{% trans "About" %}</a></li>
</ul>
</div>
</div>
</div>
{% endblock %}
<div class="container" style="margin-top: 60px;">
{% if messages %}
<!-- Messages for this instance -->
{% for message in messages %}
<div class="alert alert-{{ message.tags }}">
<a class="close" data-dismiss="alert" href="#">&times;</a>
{{ message }}
</div>
{% endfor %}
{% endif %}
<!-- Reserved for breadcrumbs -->
{% block wiki_breadcrumbs %}{% endblock %}
<!-- Main page contents go here -->
{% block wiki_contents %}{% endblock %}
<footer id="wiki-footer">
<hr />
{% block wiki_footer_logo %}
<a href="https://github.com/benjaoming/django-wiki" class="pull-right"><img src="{{ STATIC_URL }}wiki/img/github_icon.png" /></a>
{% endblock %}
{% block wiki_footer_prepend %}
{% endblock %}
<p>{% blocktrans %}Powered by <a href="http://www.django-wiki.org">django-wiki</a>, an open source application under the <a href="http://www.gnu.org/licenses/quick-guide-gplv3.html">GPLv3</a> license. Let knowledge be the cure.{% endblocktrans %}</p>
<div style="clear: both"></div>
</footer>
</div>
</div> <!-- /container -->
{% endblock %}
<script src="{{ STATIC_URL }}wiki/js/jquery.min.js"></script>
<script src="{{ STATIC_URL }}wiki/js/core.js"></script>
<script src="{{ STATIC_URL }}wiki/bootstrap/js/bootstrap.min.js"></script>
<!-- Optionally enable responsive features in IE8 -->
<script src="{{ STATIC_URL }}wiki/js/respond.min.js"></script>
{% render_block "js" %}
</body>
</html>
{# Intentionally empty, to allow easy customization with no copy-paste #}
wiki/templates/wiki/base_site.html 0 → 100644
{% load sekizai_tags i18n wiki_tags %}{% load url from future %}<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>{% block wiki_pagetitle %}{% endblock %} - django-\/\/ i K |</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="description" content="">
<meta name="author" content="www.django-wiki.org">
<!-- Le styles -->
<link href="{{ STATIC_URL }}wiki/bootstrap/css/wiki-bootstrap.min.css" rel="stylesheet">
{% render_block "css" %}
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body>
{% block wiki_body %}
{% block wiki_navbar %}
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="container">
<!-- .navbar-toggle is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-responsive-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
{% block wiki_header_branding %}
<a class="navbar-brand" href="{% url 'wiki:root' %}">django-\/\/ i K |</a>
{% endblock %}
<div class="nav-collapse collapse navbar-responsive-collapse">
<form class="navbar-form pull-right-block-on-responsive" id="wiki-search-form" method="GET" action="{% url 'wiki:search' %}">
<div class="input-group">
<input type="search" class="form-control search-query" name="q" placeholder="{% trans "Search..." %}" />
<span class="input-group-btn">
<button class="btn btn-default" type="button">
<span class="icon-search"></span>
</button>
</span>
</div><!-- /input-group -->
</form>
<div class="pull-right-block-on-responsive">
{% if user.is_authenticated %}
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
<span class="badge notification-cnt">0</span>
{{ user }}
<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="{% url 'wiki:logout' %}">
<i class="icon-off"></i>
{% trans "Log out" %}
</a>
</li>
{% include "wiki/plugins/notifications/menubaritem.html" %}
</ul>
</li>
</ul>
{% else %}
<ul class="nav navbar-nav">
<li>
<a href="{% login_url as wiki_login_url %}{{ wiki_login_url }}">{% trans "Log in" %}</a>
</li>
<li>
<a href="{% url 'wiki:signup' %}">{% trans "Sign up" %}</a>
</li>
</ul>
{% endif %}
</div>
{% block wiki_header_navlinks %}
<ul class="nav navbar-nav">
<li class="active"><a href="/">{% trans "Home" %}</a></li>
<li><a href="https://github.com/benjaoming/django-wiki" target="_blank">{% trans "About" %}</a></li>
</ul>
{% endblock %}
</div>
</div>
</div>
{% endblock %}
<div class="container" style="margin-top: 60px;">
{% if messages %}
<!-- Messages for this instance -->
{% for message in messages %}
<div class="alert alert-{{ message.tags }}">
<a class="close" data-dismiss="alert" href="#">&times;</a>
{{ message }}
</div>
{% endfor %}
{% endif %}
<!-- Reserved for breadcrumbs -->
{% block wiki_breadcrumbs %}{% endblock %}
<!-- Main page contents go here -->
{% block wiki_contents %}{% endblock %}
<footer id="wiki-footer">
<hr />
{% block wiki_footer_logo %}
<a href="https://github.com/benjaoming/django-wiki" class="pull-right"><img src="{{ STATIC_URL }}wiki/img/github_icon.png" /></a>
{% endblock %}
{% block wiki_footer_prepend %}
{% endblock %}
<p>{% blocktrans %}Powered by <a href="http://www.django-wiki.org">django-wiki</a>, an open source application under the <a href="http://www.gnu.org/licenses/quick-guide-gplv3.html">GPLv3</a> license. Let knowledge be the cure.{% endblocktrans %}</p>
<div style="clear: both"></div>
</footer>
</div>
</div> <!-- /container -->
{% endblock %}
<script src="{{ STATIC_URL }}wiki/js/jquery.min.js"></script>
<script src="{{ STATIC_URL }}wiki/js/core.js"></script>
<script src="{{ STATIC_URL }}wiki/bootstrap/js/bootstrap.min.js"></script>
<!-- Optionally enable responsive features in IE8 -->
<script src="{{ STATIC_URL }}wiki/js/respond.min.js"></script>
{% render_block "js" %}
</body>
</html>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment