search

openlibhums / hourglass

Hourglass press theme for OLH
GNU Affero General Public License v3.0
1 stars 1 forks source link

readme

Hourglass Theme for Janeway

Minimum Janeway version

1.7

Installing

  1. Clone this repository into the theme folder of your Janeway installation (with the current minimum version):

    cd src/themes
git clone git@github.com:BirkbeckCTP/hourglass.git

  2. With your Python virtual environment activated, install the Python dependencies using pip.

    pip install -r requirements.txt

  3. Install the JavaScript dependencies using NPM:

    npm install

    You should see a new node_modules file in the hourglass folder.

  4. Add the app name to your INSTALLED_APPS in settings.py:

    INSTALLED_APPS = [
   ...,
   'themes.hourglass',
   ...,
]

  5. Make changes to settings for django-components, mostly according to the installation instructions However, do not apply caching with loaders.cached.loader. Instead, use these loaders:

    'loaders': [
   'utils.template_override_middleware.Loader',
   'django.template.loaders.filesystem.Loader',
   'django_components.template_loader.Loader',
   'django.template.loaders.app_directories.Loader',
],

  6. Make changes to settings for django_minify_html if desired according to the installation instructions

Deploying to production

From the Janeway root, build assets for all themes:

python src/manage.py build_assets

You can call the same command via NPM in the theme root:

cd src/themes/hourglass
npm run build

Updating in production

cd src/themes/hourglass
git pull
pip install -r requirements.txt
npm install
python ../../manage.py build_assets

Developing

CSS

Use Tailwind classes in the HTML templates to apply styling.

In the rare case you need to apply a style to the base layer or define a custom component, make changes to src/input.css using @layer and @apply commands.

When making lots of small CSS changes that you want to see in the browser during development, you can use the hot replacement (HMR) feature provided by Tailwind. To watch for changes and recompile the CSS based on classes used automatically, use this NPM command:

npm run dev

This should work smoothly with the django-browser-reload configuration in Janeway so that you only have to save the HTML file you’re working in to see the changes take place in the browser. Templates and static CSS files are both watched and can trigger reloads independently.

Styling notes

Each section of content is given a container and relative positioning, so that it can be used as an anchor for background colors and images.

Z-index is used as follows:

JavaScript

Modify the files in js and rerun build_assets.

New files need to be added to OTHER_SOURCE_FILES in build_assets.py.

Code styling and linting

The repository is set up with a few formatters and linters:

Please run these two commands before pushing:

standard --fix
djhtml --tabwidth 2 templates

We haven’t enforced them as a pre-commit hook, because we’d need to discuss the implications of that first.

Copyediting and Content Changes

All the content for this theme is stored in GitHub, rather the Janeway content management system. You can propose changes in GitHub by following these steps:

  1. Make sure you have a GitHub account and that you’ve been added to an OLH GitHub team with the right access.

  2. Make sure you have a Janeway account for the installation that you want to edit and that your account has staff access.

  3. While logged in to the website, find the live page you want to edit, and click on the “Edit on GitHub” link. You should be taken to the GitHub page with the source code. You should also see the name of the branch at the top of the page, after the file path.

    The copyediting branch on this GitHub repository

  4. Edit the file, and then select “Commit changes”. Enter a commit message, and leave “Commit directly to the copyediting branch” selected. Select “Commit changes”.

    The commit window

  5. Open a pull request from the copyediting branch to the main branch. Or just ask a member of the tech team to do so for you. They will review your edits and merge them into the live version of the website.

Changing a link to a media file

You can change a hyperlink to a Word doc or PDF like this:

  1. Upload the new file to the appropriate Media Manager in Janeway.

  2. Copy the link Janeway gives you, and then paste it in to the appropriate page using the steps above for Copyediting and Content Changes. For example, in this line, you'd just replace the whole URL from "https" to ".doc". Keep the quotes around the link.

    https://github.com/BirkbeckCTP/hourglass/blob/af0c2b87f06c271fe80639eb80fcf4960f72dbb2/templates/custom/journal-applications.html#L120

Engineering

As an alternative, we could use django-tailwind.

Licensing

The code in this repository is licensed under AGPL 3.0.

Unless otherwise stated, the original textual content and visual designs in this repository are the copyright of Birkbeck, University of London, and they are licenced under a Creative Commons Attribution 4.0 International License (CC BY 4.0). The Open Library of Humanities and its logos are registered trademarks.

The attribution-required and trademarked content is restricted to the following folders:

The CC BY license lets you share and adapt these materials so long as you properly credit the source. Proper attribution of the OLH must be given in the following manner: