Giter Club home page Giter Club logo

papers's Introduction

Papers

An Omeka S theme based on the Papers of the War Department. It comes packaged with a Scripto theme.

Using the Scripto Theme

The only requirement for a Scripto theme is a stylesheet (.css) file within the Scripto module in the following subdirectory: Scripto\asset\css\site-themes\. The stylesheet name must match the name of your site theme directory.

This theme includes its companion Scripto theme in the following path: asset/css/scripto/papers.css. There are two ways to enable this theme.

Manually copy the CSS file to the Scripto module.

Copy your CSS file into the appropriate directory within the Scripto module. The path from within your Omeka S installation looks like this: [$ROOT]/modules/Scripto/asset/css/site-themes. If you want to make any changes to your Scripto theme, your styles will be read from that location.

Use the command line.

This method is for more technical users. The "Papers" theme uses Gulp to manage Sass/CSS compiling, and has a specific task for exporting the Scripto theme. To use this task, navigate to the root of the theme folder via the command line and type gulp scripto. This will compile the Scripto theme and place it in the correct folder, provided the Scripto module has been installed. Note: Scripto themes are not required to use Gulp or Sass, so this method may not always be an option.

Using Sass with Scripto Themes

Like Omeka S itself and many of its themes, the "Papers" theme manages its styles with Gulp and Sass. If you plan on using these tools, here are commands you'll need to run from the root of the "Papers" theme:

  • npm install: Install the theme's Node dependencies. This is required before running any tools.
  • gulp css: This command will look at your .scss files within asset/sass and export their respective CSS files into asset/css.
  • gulp css:watch: This command performs the same function as gulp css, but watches the asset/sass folder for any ongoing changes until the command is stopped.
  • gulp scripto: This command performs the same function as gulp css, but includes Scripto theme files.
  • gulp scripto:watch: This command performs the same function as gulp css:watch, but includes Scripto theme files.

Theme Configuration and Scripto

An important note: because Scripto is totally controlled with CSS, it cannot interact with theme options in a site theme, like user-set image assets or colors. If you plan on using custom backgrounds or logos for a site theme alongside a Scripto theme, save the images to a folder within your site theme and reference them using relative paths accordingly. Theme colors and styles will have to be implemented within the papers.css file in Scripto.

papers's People

Contributors

kimisgold avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.