wagtailguide

KO | EN

gitlite — search

#javascript #hacktoberfest #react #go #golang #linux #docker #macos #windows #kubernetes #vue #pytorch #ios #open-source

(★ 25)

An app for adding a CMS guide to your Wagtail CMS

wagtailguide Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Wagtail Guide

![tests](https://github.com/torchbox/wagtailguide/workflows/Test/badge.svg) [![codecov](https://codecov.io/gh/kevinhowbrook/wagtailguide/branch/master/graph/badge.svg?token=K2XKBfubBh)](https://codecov.io/gh/kevinhowbrook/wagtailguide)

## What is it?

The Wagtail Guide app adds functionality for creating and editing a guide for editors and publishers to help them create good content.

## Installation

Wagtailguide has a pypi package and can be installed with:

```bash
pip install wagtail-guide
```

After installing, add it to your settings file along with `wagtail.contrib.settings`, the settings inclusion should be placed with your other wagtail.contrib libraries:

```python
INSTALLED_APPS = [
    ...
    'wagtail_guide',
    'wagtail.contrib.settings',
]
```

## Settings and configuration

Wagtail guide has some customisation options...

**WAGTAIL_GUIDE_MENU_LABEL**
Use this setting to define your own menu label for viewing the guide.

**ADD_WAGTAIL_GUIDE_TO_HELP_MENU**
This setting will place the guide within the 'Help' menu.

**HIDE_WAGTAIL_CORE_EDITOR_GUIDE**
You can use this setting to turn off the Wagtail core Editor Guide link

### Examples of customisation via settings

Here is an example of a custom menu label (outlined here in orange),
and placing the editor guide link in the help menu:

```python
WAGTAIL_GUIDE_SETTINGS = {
    "ADD_WAGTAIL_GUIDE_TO_HELP_MENU": True,
    "WAGTAIL_GUIDE_MENU_LABEL": "CMS Publishing Guide",
    "HIDE_WAGTAIL_CORE_EDITOR_GUIDE": False,
}
```

![custom label](https://raw.githubusercontent.com/torchbox/wagtailguide/master/screenshots/custom-label.png)

Here is an example of hiding the core Editor Guide link and just using ours:

```python
WAGTAIL_GUIDE_SETTINGS = {
    "ADD_WAGTAIL_GUIDE_TO_HELP_MENU": True,
    "WAGTAIL_GUIDE_MENU_LABEL": "CMS Publishing Guide",
    "HIDE_WAGTAIL_CORE_EDITOR_GUIDE": True,
}
```

![remove help](https://raw.githubusercontent.com/torchbox/wagtailguide/master/screenshots/remove-help.png)

You can define them in your project settings file like this:

```python
WAGTAIL_GUIDE_SETTINGS = {
    "ADD_WAGTAIL_GUIDE_TO_HELP_MENU": False,
    "WAGTAIL_GUIDE_MENU_LABEL": "WG guide menu label",
    "HIDE_WAGTAIL_CORE_EDITOR_GUIDE": True,
}
```

## Usage

To edit the guide, the user needs to be an admin, or have the `Manage editor guide` 'change' value checked in their user group permissions.

### Editing the guide

To edit the guide, from the left hand menu open settings > then click 'Manage editor guide'. Edit your content and then save.

![guide edit](https://raw.githubusercontent.com/torchbox/wagtailguide/master/screenshots/editing.png)

#### Guide navigation menu

If more than one 'heading' blocks are added to the content, an automatic menu will be displayed at the top of the guide under the heading 'Contents'

### Viewing the guide

Once logged in, a new menu icon towards the bottom of the left hand menu will be visible labeled as 'Editor guide':

![guide view](https://raw.githubusercontent.com/torchbox/wagtailguide/master/screenshots/default.png)

## Dependencies

Wagtail Guide requires `wagtail>=5.2`

## Contributing

We welcome contributions to this project, see [CONTRIBUTING.md](docs/CONTRIBUTING.md) for more details.

wagtailguide

wagtailguide Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

wagtailguide

wagtailguide Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README