thesis v0.3.4 API Reference
Modules
Thesis is a simple and straightforward content editor for Phoenix websites. It doesn't hijack your development workflow, but rather bolts on and works seamlessly with your existing web application
Thesis.Auth is an Elixir "behaviour" that defines the public function interface necessary for Thesis to determine whether the current session has the authority to edit
Represents a page and page_content backup
Provides a plug that preloads any Thesis content for a page.
Typically, you'll add this to your web/web.ex
file, under the controller
function
Pre-populates the conn with a Thesis page (if it exists) and its contents. Also checks with the host app if the current page is editable
Thesis.EctoStore is the most commonly-used store for Thesis pages and content. It interfaces with the host application's repo (which is provided in the config.exs of the host applicaton)
Represents a file
Builds a map of Notifications that is passed to the client side. The key should be a representation of the category/type of notification (this is used to determine where and how it's displayed). The value is a list of notification strings
Represents a page (dynamic or static), and also contains meta data like title, description, and redirect if necessary
Content areas for a specific page. Includes meta information about the type of content as well as other info for specific content blocks
Renders editable page content, based on the content_type
Handles file uploads
Creates the routes that Thesis uses to handle requests from its javascript editor client as well as static assets
This is a placeholder for potential future Amazon S3 integration
Thesis.Store is an Elixir "behaviour" that defines the public function interface necessary for Thesis to use a particular store module
Thesis.Uploader is an Elixir "behaviour" that defines the public function interface necessary for Thesis to upload files and images
Module that provides helper functions
Provides several view helper functions, including the primary content/4
function. Look at individual function documentation to learn more about them
Mix Tasks
Installs Thesis by adding these to your host app