Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gocom committed Mar 2, 2019
1 parent d1cd800 commit 8134851
Showing 1 changed file with 9 additions and 46 deletions.
55 changes: 9 additions & 46 deletions README.textile
Original file line number Diff line number Diff line change
@@ -1,68 +1,31 @@
h1. rah_flat

"Download":https://github.com/gocom/rah_flat/releases | "Packagist":https://packagist.org/packages/rah/rah_flat | "Donate":http://rahforum.biz/donate/rah_flat
"Download":https://github.com/gocom/rah_flat/releases | "Packagist":https://packagist.org/packages/rah/rah_flat | "Donate":https://rahforum.biz/donate/rah_flat

This plugin makes your "Textpattern CMS":http://www.textpattern.com database more flat, manageable and editable. Edit templates, forms, pages, preferences and sections as flat files. Use any editor, work in teams and store your website's source under your favorite "version control system":http://en.wikipedia.org/wiki/Revision_control.
Runs theme imp

This plugin makes your "Textpattern CMS":https://textpattern.com import flat frontend themes automatically to the database while your installation is in debugging or testing mode.

*Warning: this plugin will permanently remove your current templates when activated.*

h2. Installing

Using "Composer":http://getcomposer.org:
Using "Composer":https://getcomposer.org:

bc. $ composer require rah/rah_flat:*

Or "download":https://github.com/gocom/rah_flat/releases a plugin package.

h2. Requirements

* Textpattern 4.6.0 or newer.
* PHP 5.3.6 or newer.

h2. Basics

Rah_flat imports normal, flat files from a specified directory to your Textpattern database. This, in essence, lets you to edit your database contents from any regular editor and store the source as flat files.

Rah_flat comes with built-in support for a few essential content types: styles, forms, pages, preferences and sections. See the "templates":https://github.com/gocom/rah_flat/tree/master/templates directory on GitHub for an example how this all works.

Your flat files are imported to the database:

* Automatically on the background when the site is either in Debugging or Testing mode.
* When the public callback hook URL is accessed. The URL can be used for deployment.

If you want to exclude a certain content type from importing, just don't create a directory for it. No directory, and rah_flat will leave the database alone when it comes to that content type.

h2. Preferences

The plugin has set of preferences you can find on Textpattern's normal preferences panel.

h3. Path to the templates directory

Specifies path to the root templates directory containing all the content-type specific directories. This path is relative to your 'textpattern' installation directory. For example, a path @../templates@ would point to a directory located in the same directory as your _textpattern_ directory and the main _index.php_ file.

h3. Security key for the public callback

Security key for the public callback hook URL. Importing is done when the URL is accessed. The URL follows the format of:

bc. http://example.com/?rah_flat_key={yourKey}

Where @http://example.com/@ is your site's URL, and @{yourKey}@ is the security key you specified.

h2. Toolshed notice

This is a toolshed project. Experimental and not part of the main supported product line of Rah. Not yet at least. Please use at your own risk.
* Textpattern 4.7.0 or newer.
* PHP 5.4.0 or newer.

h2. Changelog

h3. Version 0.4.0 - upcoming
h3. Version 1.0.0 - upcoming

* Added: Import template variables.
* Added: Import translation strings.
* Added: Reads template files recursively, allowing the use of organizational sub-directories.
* Added: Use the parent directory as the form type, if it's not specified in the filename itself.
* Added: Do not delete essential forms from the database.
* Added: Do not delete pages or styles that are used by a section.
* Now requires Textpattern 4.6.0 or newer.
* First release using core Textpattern 4.7.0 theme functionality.

h3. Version 0.3.0 - 2014/03/28

Expand Down

0 comments on commit 8134851

Please sign in to comment.