*********************
djangocms-lab-members
*********************
``djangocms-lab-members`` is a Django app to extend ``django-lab-members`` with django CMS-specific features.
Source code is available on GitHub at `mfcovington/djangocms-lab-members <https://github.com/mfcovington/djangocms-lab-members>`_. Information about and source code for ``django-lab-members`` is available on GitHub at `mfcovington/django-lab-members <https://github.com/mfcovington/django-lab-members>`_.
.. contents:: :local:
Installation
============
**PyPI**
.. code-block:: sh
pip install djangocms-lab-members
**GitHub (development branch)**
.. code-block:: sh
pip install git+http://github.com/mfcovington/djangocms-lab-members.git@develop
Configuration
=============
- Ignore instructions for `django-lab-members <https://github.com/mfcovington/django-lab-members>`_, the non-django CMS app that this app extends.
- `Install django CMS and start a project <http://docs.django-cms.org/en/latest/introduction/install.html>`_, if one doesn't already exist.
- Unless you use this app as part of `djangocms-lab-site <https://github.com/mfcovington/djangocms-lab-site>`_ or plan to style the app from scratch, you will want to choose the ``Use Twitter Bootstrap Theme`` option (when running ``djangocms``) and then edit the resulting ``templates/base.html``.
- This will add style that looks like Bootstrap 2. To use Bootstrap 3 styling, remove the following line for the ``bootstrap-theme.min.css`` stylesheet from ``templates/base.html``:
.. code-block:: python
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.x.x/css/bootstrap-theme.min.css">
- The default menu settings for django CMS using Bootstrap will allow the user to access specific lab members via a dropdown menu, but will not give easy access to the summary page of all lab member. To fix this do one of the following:
- In ``templates/base.html``, change ``{% show_menu 0 1 100 100 "menu.html" %}`` to ``{% show_menu 0 0 100 100 "menu.html" %}``, or
- Use a split button dropdowns by changing that line to `{% show_menu 0 100 1 1 '_menu.html' %}` and populate `_menu.html` as done in `djangocms-lab-site <https://github.com/mfcovington/djangocms-lab-site>`_.
- Edit the project's ``settings.py`` file.
- Add ``cms_lab_members`` and its dependencies to your ``INSTALLED_APPS`` setting:
.. code-block:: python
INSTALLED_APPS = (
# ...
'cms_lab_members',
'cms_lab_publications',
'easy_thumbnails',
'filer',
'friendlytagloader',
'lab_members',
'taggit',
)
- Add ``easy_thumbnail`` settings:
.. code-block:: python
# For easy_thumbnails to support retina displays (recent MacBooks, iOS)
THUMBNAIL_HIGH_RESOLUTION = True
THUMBNAIL_QUALITY = 95
THUMBNAIL_PROCESSORS = (
'easy_thumbnails.processors.colorspace',
'easy_thumbnails.processors.autocrop',
'filer.thumbnail_processors.scale_and_crop_with_subject_location',
'easy_thumbnails.processors.filters',
)
THUMBNAIL_PRESERVE_EXTENSIONS = ('png', 'gif')
THUMBNAIL_SUBDIR = 'versions'
- Pre-populate placeholder content for research/personal interests and sidebar:
.. code-block:: python
# Pre-populate placeholder content
CMS_PLACEHOLDER_CONF = {
# ...
'research interests': {
'default_plugins': [
{
'plugin_type': 'TextPlugin',
'values': {
'body':"<p><em>[Enter 'Edit Mode' and double-click here to add your research interests.]</em></p>",
},
},
],
},
'personal interests': {
'default_plugins': [
{
'plugin_type': 'TextPlugin',
'values': {
'body':"<p><em>[Enter 'Edit Mode' and double-click here to add your personal interests.]</em></p>",
},
},
],
},
'scientist sidebar': {
'default_plugins': [
{
'plugin_type': 'TextPlugin',
'values': {
'body':"<p><em>[Enter 'Edit Mode' and double-click here to add sidebar content.]</em></p>",
},
},
],
},
}
Migrations
==========
Create and perform migrations for ``cms_lab_members`` and its dependencies:
.. code-block:: sh
python manage.py makemigrations cms_lab_members
python manage.py makemigrations lab_members
python manage.py makemigrations cms_lab_publications
python manage.py migrate
Usage
=====
- Start the development server:
.. code-block:: sh
python manage.py runserver
- Visit: ``http://127.0.0.1:8000/``
- Create a CMS page.
- Attach the ``Lab Members App`` under ``Advanced Settings`` for the page.
*Version 0.2.0*
Revision History
================
0.2.0 2015-11-10
- Add alumni fieldset to admin
- This bumps ``djangocms-lab-members`` requirement to version ``0.3.0``
- Add instructions to double-click placeholders when editing
- Update README with more complete and accurate instructions
- Prepare for distribution via PyPI
0.1.5 2015-05-08
- Add ``Lab Alumni`` node to dropdown menu
- Update README to pre-populate placeholder content via settings
- Minor behind-the-scenes improvements
0.1.4 2015-05-01
- Limit dropdown menu to current lab members
0.1.3 2015-04-21
- Subclass ``PlaceholderAdminMixin`` from ``CMSScientistAdmin`` to provide admin support
0.1.2 2015-04-19
- Group CMS plugin under ``Lab Plugins`` module
0.1.1 2015-04-13
- Customize ``Scientist`` plugin style
0.1.0 2015-04-10
- A Django app to extend ``django-lab-members`` with django CMS-specific features