Extension Frontpage


Extension Basics

Title
Frontpage
Name
ckanext-frontpage
Type
Public extension
Description
frontpage management ext
CKAN versions
Download-Url (zip)
Last commit
8 years ago (2017-03-24 19:09:17)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-frontpage

This extension gives you an easy way to add simple frontpage to CKAN. THis extension should be installed with the ckanext-monsanto theme

By default you can add frontpage to the main CKAN menu.

Works for ckan>=2.5

Installation

Use pip to install this plugin. This example installs it in /home/www-data/pyenv, assuming you have setup a virtualenv there:

source /home/www-data/pyenv/bin/activate
pip install -e 'git+https://github.com/ckan/ckanext-frontpage.git#egg=ckanext-frontpage'

Make sure to add frontpage to ckan.plugins in your config file:

ckan.plugins = frontpage

Configuration

To enable HTML output for the frontpage (along with Markdown), add the following to your config:

ckanext.frontpage.allow_html = True

By default this option is set to False. Note that this feature is only available for CKAN >= 2.3. For older versions of CKAN, this option has no effect. Use this option with care and only allow this if you trust the input of your users.

If you want to use the WYSIWYG editor instead of Markdown:

ckanext.frontpage.editor = medium

or

ckanext.frontpage.editor = ckeditor

This enables either the medium or ckeditor

Helper Functions

custom helpers available to the templates

get_frontpage_content -- returns the content when the ID is passed for that content
get_frontpage_list -- retuns all non private content defaults to 5 but you can pass a number this will order them by publish data and will exclude entries without one
get_featured_org_count -- get the number or orgs featured
get_tracking -- returns tracking results for a package ID
get_tracking_total -- process tracking totals and exports them to file 

all hel

Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Use pip to install this plugin. This example installs it in /home/www-data/pyenv, assuming you have setup a virtualenv there:

source /home/www-data/pyenv/bin/activate
pip install -e 'git+https://github.com/ckan/ckanext-frontpage.git#egg=ckanext-frontpage'

Make sure to add frontpage to ckan.plugins in your config file:

ckan.plugins = frontpage
Plugins to configure (ckan.ini)
frontpage
CKAN Settings (ckan.ini)
# ckanext.frontpage.allow_html = True
# ckanext.frontpage.editor = medium
# ckanext.frontpage.editor = ckeditor
DB migration to be executed
(not set)
<< back to Extensions