Skip to content

Commit 19100e0

Browse files
committed
fix merge conflicts
1 parent 88bb32b commit 19100e0

File tree

1 file changed

+40
-18
lines changed

1 file changed

+40
-18
lines changed

README.md

+40-18
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@
2424
* [Installation](#installation)
2525
* [Usage](#usage)
2626
* [Settings](#settings)
27-
* [Templates](#templates)
2827
* [Signals](#signals)
2928
* [Management Commands](#management-commands)
3029
* [Views](#views)
30+
* [Templates](#templates)
3131
* [Change Log](#change-log)
3232
* [History](#history)
3333
* [Contribute](#contribute)
@@ -131,7 +131,7 @@ this tag to show the number of invites remaining for a user:
131131

132132
You’ll then need to include eldarion-ajax:
133133

134-
```javascript
134+
```django
135135
<script>require('eldarion-ajax');</script>
136136
```
137137

@@ -151,22 +151,6 @@ In order to enable unlimited invitations, set this to -1.
151151

152152
Default: 0
153153

154-
### Templates
155-
156-
`pinax-invitations` comes with minimal template snippets that get rendered with template tags.
157-
158-
#### _invite_form.html
159-
160-
A snippet that renders the invite form as well as a div to hold the contents
161-
of the response from the form AJAX submission.
162-
163-
#### _invited.html
164-
165-
An unordered list of people you have invited that is linked to their profile when they join the site.
166-
167-
#### _invites_remaining.html
168-
169-
Fragment displays how many invites a particular user has.
170154

171155
### Signals
172156

@@ -302,6 +286,44 @@ Returns:
302286
```
303287

304288

289+
### Templates
290+
291+
`pinax-invitations` uses minimal template snippets rendered with template tags.
292+
293+
Default templates are provided by the `pinax-templates` app in the
294+
[invitations](https://github.com/pinax/pinax-templates/tree/master/pinax/templates/templates/pinax/invitations)
295+
section of that project.
296+
297+
Reference pinax-templates
298+
[installation instructions](https://github.com/pinax/pinax-templates/blob/master/README.md#installation)
299+
to include these templates in your project.
300+
301+
#### Customizing Templates
302+
303+
Override the default `pinax-templates` templates by copying them into your project
304+
subdirectory `pinax/invitations/` on the template path and modifying as needed.
305+
306+
For example if your project doesn't use Bootstrap, copy the desired templates
307+
then remove Bootstrap and Font Awesome class names from your copies.
308+
Remove class references like `class="btn btn-success"` and `class="icon icon-pencil"` as well as
309+
`bootstrap` from the `{% load i18n bootstrap %}` statement.
310+
Since `bootstrap` template tags and filters are no longer loaded, you'll also need to update
311+
`{{ form|bootstrap }}` to `{{ form }}` since the "bootstrap" filter is no longer available.
312+
313+
#### `_invite_form.html`
314+
315+
A snippet that renders the invite form as well as a div to hold the contents
316+
of the response from the form AJAX submission.
317+
318+
#### `_invited.html`
319+
320+
An unordered list of people you have invited that is linked to their profile when they join the site.
321+
322+
#### `_invites_remaining.html`
323+
324+
Fragment displays how many invites a particular user has.
325+
326+
305327
## Change Log
306328

307329
### 6.1.1

0 commit comments

Comments
 (0)