Screenshot showing the example puzzle rendered by the Crossword Puzzle formatter.

Add Crossword Puzzles to Your Site

This module makes it easy to add crossword puzzles that are playable in the browser to your Drupal site. It is not for authoring puzzles; rather, it allows you to upload crossword puzzle files that have been created elsewhere.

This module creates a Crossword field type which can then be rendered in many different ways as a playable puzzle, an image, or a file. The module currently supports Across Lite txt or puz files. An example file can be found at the bottom of this project page or by clicking this link.

Updating from 8.x-1.x to 2.0.x

The 2.0.x releases are compatible with D10. Upgrading from 8.x-1.x to 2.0.x is easy! There are no update hooks or any special steps required.

Documentation

The documentation guide contains many screenshots and descriptions of how to complete the most essential tasks as well as guides on the submodules. There are even links to real sites that use this module.

Sub-Modules

There are sub-modules that provide additional features.

  1. crossword_image: Provides features for generating images from crossword files. This is useful for creating teasers or for generating downloadable solutions.
  2. crossword_colors: Provides UI to configure highlight and text colors.
  3. crossword_media: Provides integration with core Media. The configurable thumbnail is provided by crossword_image.
  4. crossword_token: Provides tokens for crossword files. These are special file tokens accessed like [node:field_crossword:entity:crossword_dimensions] or [media:field_crossword:entity:crossword_author].
  5. crossword_download: Provides Field Formatters related to downloading files.
  6. crossword_pseudofields: Provides pseudofields representing pieces of a Crossword puzzle like author and title.
  7. crossword_status: Uses client-side techniques to add classes to crossword fields (rendered in teasers, say) based on completion status, such as solved or in-progress.
  8. crossword_contest: Offers a framework for a low-stakes puzzle-solving contest using server-side validation.

Requirements

The main Crossword module has no requirements outside of core. Some of the sub-modules have additional requirements. For example, Crossword Token has a dependency on Token while Crossword Download has a dependency on File Download Link.

Installation and Configuration

Please see the Quick Start Guide for a walk through.

Recommended Modules

When using the Crossword module, you may want users to access the same content in multiple view modes, each with its own route. This can be done using Views or the contrib module View Mode Page. You might be able to use Entity Print to convert Crossword files to pdf.

Similar Modules

There are no remotely similar Drupal modules. There are, however, lots of ways to embed a Crossword puzzle in a website. While there is no other solution that is specifically tailored toward Drupal, you may be interested in exploring what other options are available. I recommend a webpage from saweyer that discusses and displays several applets.

Miscellany

Please Submit UX Issues

Issues related to UX are highly encouraged. If you have a bug report or feature request regarding the UX of this module, please submit an issue. Also feel free to throw your support behind existing UX suggestions you agree with. Of course issues unrelated to UX are appreciated too!

Accessibility

#D8AX - I pledge to make this module as accessible as it can be. If you find any flaws, please submit an issue. Help me fix them if you can.

I have made a good faith effort to make the default Crossword Puzzle formatter compatible with screenreader technology. If you have suggestions for ways to make the experience more accessible, please put in an issue!

Supporting organizations: 
Ongoing development
alpha to stable release

Project information

Releases