Skip to content

Latest commit

 

History

History
126 lines (100 loc) · 4.05 KB

Readme.md

File metadata and controls

126 lines (100 loc) · 4.05 KB
Raw

IEEE Passau Flatdesign Template

This is a Pelican template. Initially this design was created for Wordpress and can be found here.

It features multi-language usage, a calendar, filled by events, fully searchable content (javascript-based), a mailman-newsletter signup form, submenus for static pages and diverse small additions that were necessary for us.

theme preview

Setup

This theme uses several plugins, disabling them may work but was up to now not tested. Necessary plugins are:

  • events (creates the calendar, *.ics files)
  • i18n_subsites (multi-language plugin)
  • tipuesearch (javascript-based search)
  • sitemap
  • photos (gallery plugin)
  • assets (minify css+js)

In order to make these plugins work please pip install -r requirements.txt

Additionally you have to enable the jinja2 do statements, assets, multilanguage and add some functions to your pelican config files in order to make the theme work properly:

JINJA_EXTENSIONS = ['jinja2.ext.do', 'webassets.ext.jinja2.AssetsExtions', 'jinja2.ext.i18n']

# path for css files (default values of assets plugin does not work with multilanguage
# so we just specify the css folder of this theme
ASSET_SOURCE_PATHS = ['static/css']

# this method is necessary as the default language is '' isntead of 'de'
# so we need a converter for proper language handling
def getOtherLanguage(path):
    if path.endswith("en"):
        return u'de'
    else:
        return u'en'

def getCurrentLanguage(path):
    return getOtherLanguage(getOtherLanguage))

def toMonthNum(num):
    months = { 1 : 'Jan',
               2 : 'Feb',
               3 : 'Mar',
               4 : 'Apr',
               5 : 'May',
               6 : 'Jun',
               7 : 'Jul',
               8 : 'Aug',
               9 : 'Sep',
              10 : 'Oct',
              11 : 'Nov',
              12 : 'Dec'
             }
    return months[num]

def removeLanguagePrefix(path):
    if path.startswith("../en/") or path.startswith("../de/"):
        return path[6:]
    else:
        return path

def shouldArticleBeDisplayed(article):
    if hasattr(article, 'event-start'):
        evStart = datetime.strptime(getattr(article, 'event-start'), '%Y-%m-%d %H:%M')

        if (not SHOW_PAST_EVENTS_IN_BLOG and evStart < datetime.now())\
                or (evStart > datetime.now() and evStart-datetime.now() > SHOW_FUTURE_EVENTS_IN_BLOG_UNTIL):
            return False

    return True


JINJA_FILTERS = {
        'getOtherLanguage': getOtherLanguage,
        'getCurrentLanguage': getCurrentLanguage,
        'toMonthNum': toMonthNum,
        'removeLanguagePrefix': removeLanguagePrefix,
        'shouldArticleBeDisplayed': shouldArticleBeDisplayed
        }

Customization

We provide several variables that can be used to customize the theme:

# external links which should be added as menu items
EXTERNAL_LINKS = [
    ('//linktopage', {'de': 'titel', 'en': 'title'})
]

#sidebar social widget
SOCIAL = [
    ('theme/img/icons/facebook.png', '//facebook'),
    ('theme/img/icons/googleplus.png', '//gplus'),
    ('theme/img/icons/twitter.png', '//twitter')
]
ADD_RSS = True

# setting the mail address of the newsletter
MAILINGLIST = '[email protected]'

# where should the sponsors widget occur on the index (blog) page
SPONSOR_WIDGET_PLACE = 2

# header picture settings
LOGO = 'header/ieee-logo.svg'
HEADER_PICTURE = 'header/branch_header.png'
DEFAULT_ARTICLE_HEADER = 'header/branch_header.png'
DEFAULT_PAGE_HEADER = 'header/branch_header.png'

# sponsors settings
SPONSORS_PICTURE_FOLDER = 'sponsors'
SPONSORS = ['a.png', 'b.png', 'c.png']
SPONSORS_PAGE = 'pages/sponsors'

# footer links
FOOTER_LINK_IMPRINT = '//imprint'
FOOTER_LINK_ORGANISATION = '//organisation'
FOOTER_ORGANISATION_NAME = 'Name'

# customization of events in timeline
SHOW_PAST_EVENTS_IN_BLOG = False
SHOW_FUTURE_EVENTS_IN_BLOG_UNTIL = timedelta(weeks=4)

For a working configuration you can look here.