README
author Dan Fuhry <dan@enanocms.org>
Tue, 03 Aug 2010 22:10:07 -0400
changeset 1288 bf59bcc79baf
parent 1273 3351055b467e
child 1349 3f7bf1a22b45
permissions -rw-r--r--
Fixed no plugins showing up in sidebar create block page
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
     1
Enano CMS
1273
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
     2
Version 1.1.8
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
     3
-----------------------------
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
     4
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
     5
Thanks for downloading Enano! If you're looking for an installation guide,
234
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
     6
you can find it at <http://docs.enanocms.org/Help:2.1>.
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
     7
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
     8
COPYRIGHT
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
     9
-----------------------------
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    10
234
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    11
Enano CMS
1273
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    12
Copyright (C) 2006-2010 Dan Fuhry. All rights except those explicitly granted
234
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    13
by the included license agreement reserved.
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    14
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    15
PHILOSOPHY
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    16
-----------------------------
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    17
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    18
We strongly believe in the idea of Free Software. Enano is released under the
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    19
GNU General Public License; see the file GPL included with this release for
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    20
details.
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    21
1273
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    22
LICENSE
234
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    23
-----------------------------
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    24
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    25
This program is Free Software; you can redistribute it and/or modify it under
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    26
the terms of the GNU General Public License as published by the Free Software
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    27
Foundation; either version 2 of the License, or (at your option) any later
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    28
version.
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    29
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    30
This program is distributed in the hope that it will be useful, but WITHOUT ANY
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    31
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    32
PARTICULAR PURPOSE. See the GNU General Public License for details.
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    33
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    34
You should have received a copy of the GNU General Public License along with
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    35
this program; if not, write to:
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    36
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    37
  Free Software Foundation, Inc.,
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    38
  51 Franklin Street, Fifth Floor
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    39
  Boston, MA 02110-1301, USA
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    40
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    41
-----------------------------
d5dff8148dfe Renaming config.php and .htaccess to *.new to allow tarbombing an Enano installation with no adverse effects; first attempt, may not work right.
Dan
parents: 120
diff changeset
    42
1273
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    43
Most of the PHP code in Enano was written by Dan Fuhry. Some parts were
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    44
borrowed from other projects that are also released under Free Software
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    45
licenses; see the various files under the licenses/ directory included
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    46
with this release for details.
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    47
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    48
CHANGES IN THIS RELEASE
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    49
-----------------------------
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    50
1273
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    51
Please see <http://enanocms.org/Release_notes/1.1.8> for a list of changes in
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    52
this release.
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    53
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    54
UPGRADING FROM PREVIOUS RELEASES
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    55
-----------------------------
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    56
685
17ebe24cdf85 Rebranded as 1.1.5 (Caoineag alpha 5) and fixed a couple bugs related to CDN support in template_nodb and installerUI. Updated readme.
Dan
parents: 634
diff changeset
    57
This archive includes a script that can migrate an Enano 1.0.x installation to
1087
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    58
Enano 1.2. Before running the migration script, you should always be sure to
1273
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    59
upgrade to the latest version of Enano 1.0.x (1.0.6pl2 at the time of this
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    60
writing). Migration is NOT REVERSIBLE. This is beta-quality code. DO NOT UNDER
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    61
ANY CIRCUMSTANCES UPGRADE A PRODUCTION SITE.
392
3395ecddd831 Updated readme file for 1.1.1
Dan
parents: 320
diff changeset
    62
1087
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    63
Upgrades from any 1.1.x version are fully supported and generally more stable
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    64
than upgrades from 1.0 because of all the API changes. If you experience
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    65
trouble upgrading from a 1.0 version to 1.2, try upgrading first to version
1273
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    66
1.1.7 or so.
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    67
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    68
Enano 1.1.8 changes to the use of database revisions instead of the Enano core
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    69
version number to track changes. Upgrades from 1.1.7 don't require running the
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    70
upgrade script, although you should re-import your English language to make
3351055b467e Updated README and KNOWN_BUGS for 1.1.8
Dan
parents: 1087
diff changeset
    71
effective the user interface changes.
428
921bae9104b0 Updated readme file for 1.1.2 release
Dan
parents: 392
diff changeset
    72
392
3395ecddd831 Updated readme file for 1.1.1
Dan
parents: 320
diff changeset
    73
TRANSLATING ENANO
3395ecddd831 Updated readme file for 1.1.1
Dan
parents: 320
diff changeset
    74
-----------------------------
3395ecddd831 Updated readme file for 1.1.1
Dan
parents: 320
diff changeset
    75
1087
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    76
There have been quite a few changes to strings in the 1.2 series. Since this
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    77
is a beta, you probably don't want to do a lot of translation because you'll
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    78
be doing a TON more strings at every release. HOWEVER, we're looking for
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    79
people to sign up and volunteer for translation efforts later on. If you have
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    80
a native or very good knowledge of a language, drop us an e-mail and we'll get
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    81
you onto the translator list and eventually onto a mailing list specifically
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    82
for l10n if that effort becomes big enough.
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    83
1087
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    84
PLUG-INS
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    85
-----------------------------
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    86
1087
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    87
Most Enano features you see are actually the work of plugins. You can see a
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    88
gallery of plugins at <http://enanocms.org/Category:Plugins>. Most of the
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    89
plugins there work under Enano 1.2, but some don't. Plugins with known
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    90
compatibility problems are marked; if you don't see any notes to the
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    91
contrary, it's probably compatible with Enano 1.2.
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    92
1087
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    93
THEMES
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    94
-----------------------------
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    95
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
    96
You can find more themes for Enano at <http://enanocms.org/Category:Themes>.
1087
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    97
We're not doing too great with developing themes, and what we have developed
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    98
often doesn't make it up to the website. :) So your choices on the website
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
    99
look a little bit more limited than they really are.
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   100
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   101
Unlike plugins, themes are generally very easy to port from 1.0 to 1.2. Copy
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   102
over acledit.tpl, comment.tpl, and toolbar.tpl from a 1.2 theme and remove
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   103
the <script> tag that includes jsres.php, replacing it with {JS_HEADER} in
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   104
header.tpl. Then put {JS_FOOTER} right before </body> in footer.tpl. Do the
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   105
same in simple_header.tpl and simple_footer.tpl. That's pretty much it.
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
   106
685
17ebe24cdf85 Rebranded as 1.1.5 (Caoineag alpha 5) and fixed a couple bugs related to CDN support in template_nodb and installerUI. Updated readme.
Dan
parents: 634
diff changeset
   107
PLUGIN DEVELOPMENT
17ebe24cdf85 Rebranded as 1.1.5 (Caoineag alpha 5) and fixed a couple bugs related to CDN support in template_nodb and installerUI. Updated readme.
Dan
parents: 634
diff changeset
   108
-----------------------------
17ebe24cdf85 Rebranded as 1.1.5 (Caoineag alpha 5) and fixed a couple bugs related to CDN support in template_nodb and installerUI. Updated readme.
Dan
parents: 634
diff changeset
   109
17ebe24cdf85 Rebranded as 1.1.5 (Caoineag alpha 5) and fixed a couple bugs related to CDN support in template_nodb and installerUI. Updated readme.
Dan
parents: 634
diff changeset
   110
The plugin API in Enano 1.1 has been dramatically revamped from 1.0. Some
17ebe24cdf85 Rebranded as 1.1.5 (Caoineag alpha 5) and fixed a couple bugs related to CDN support in template_nodb and installerUI. Updated readme.
Dan
parents: 634
diff changeset
   111
effort has been made to allow 1.0.x plugins that don't hook very deeply to
17ebe24cdf85 Rebranded as 1.1.5 (Caoineag alpha 5) and fixed a couple bugs related to CDN support in template_nodb and installerUI. Updated readme.
Dan
parents: 634
diff changeset
   112
continue to work; however with all of the new functionality (localization
17ebe24cdf85 Rebranded as 1.1.5 (Caoineag alpha 5) and fixed a couple bugs related to CDN support in template_nodb and installerUI. Updated readme.
Dan
parents: 634
diff changeset
   113
especially) we recommend that developers take the time to learn how to use the
1087
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   114
newer parts of the Enano platform. Enano tries to be very developer-friendly;
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   115
our full API documentation is at <http://docs.enanocms.org/API>.
685
17ebe24cdf85 Rebranded as 1.1.5 (Caoineag alpha 5) and fixed a couple bugs related to CDN support in template_nodb and installerUI. Updated readme.
Dan
parents: 634
diff changeset
   116
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
   117
GETTING SUPPORT
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
   118
-----------------------------
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
   119
1087
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   120
This is a beta release. No support of any kind will be provided, but proper bug
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   121
reports are appreciated. See the Enano forums at <http://forum.enanocms.org/>
c3db5e44f8f3 Updated readme for 1.1.7/1.2 series in general
Dan
parents: 801
diff changeset
   122
for more information.
69
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
   123
63638a42cee9 Removed KNOWN_BUGS and TODO and added README; fixed file permissions yet again
Dan
parents:
diff changeset
   124
Have fun with Enano!