Menu
▾
▴
[phpws-comm-commits] modules/article/docs INSTALL.txt,NONE,1.1 INTRODUCTION.txt,NONE,1.1 LICENSE.txt,NONE,1.1 PAGE_INSERT_README.txt,NONE,1.1 TEMPLATE.txt,NONE,1.1
|
From: <ada...@us...> - 2003-07-09 20:24:28
|
Update of /cvsroot/phpwebsite-comm/modules/article/docs
In directory sc8-pr-cvs1:/tmp/cvs-serv30555/docs
Added Files:
INSTALL.txt INTRODUCTION.txt LICENSE.txt
PAGE_INSERT_README.txt TEMPLATE.txt
Log Message:
Initial commit to CVS
--- NEW FILE: INSTALL.txt ---
Document - ArticleManager Installation
Author - Eloi George <el...@by...>
Updated - 3/28/2003
-----------------------------------------------------------------------------
LICENSE
-----------------------------------------------------------------------------
LGPL Licence. See LICENSE.txt
-----------------------------------------------------------------------------
INSTALLATION
-----------------------------------------------------------------------------
To install Article Manager simply follow these steps:
1. Place the articlemanager files into the phpwebsite/mod/article/ directory.
2. Make sure the permissions on the phpwebsite/images/ directory allow the web server to write.
3. Open your browser and point it to your phpWebSite site.
4. Open the "Boost" module as an administrator or deity and select the "Install" button for ArticleManager.
5. Enjoy!
-----------------------------------------------------------------------------
IMPORT DATA FROM PAGEMASTER or ANNOUNCE
-----------------------------------------------------------------------------
IMPORTANT!:
Back up your entire database first!
The import script changes data for the menus, categories, approval and comments modules so that they'll automatically point to the new pages.
There is no export script because the best way of reverting data is to restore the entire database from a recent backup.
SUGGESTION:
As with all data conversions, sometimes bad data can screw up the process. I've tried to account for all potential problems, but to be sure that everything is converted properly I suggest that you make a small change to your /core/Database.php file. Change line #461 from this:
if($this->query($sql, FALSE, TRUE)){
to this:
if($this->query($sql, FALSE, FALSE)){
So you can see any error messages that the database creates. If you want to keep track of when phpWS screws up, don't change it back.
1. Make the convert/reroute/ directory writable (apache.apache, nobody.nobody, 777).
2. Make sure the images/articlemanager/PM & images/articlemanager/ANN directories are writable (apache.apache, nobody.nobody, 777).
3. Log in as a Diety.
4. To import PageMaster, run www.yoursite.com/index.php?module=article&config=import_pagemaster
5. To import Announcements, run www.yoursite.com/index.php?module=article&config=import_announce
6. Log out & log back in so the menu data can be reset.
7. Change the write permissions on the convert/reroute directory to not writable.
8. Back up the files in the convert/reroute directory. They won't ever change again.
-----------------------------------------------------------------------------
UNINSTALLING ARTICLE MANAGER
-----------------------------------------------------------------------------
WARNING!!
Running this file will result in loss of data! It is suggested you backup your phpwebsite/images/articlemanager/ directory and backup your database.
I am not responsible for any loss of data nor is Appalachian State University, developers of phpWebsite.
To Uninstall ArticleManager simply follow these steps:
1. Make sure the permissions on the phpwebsite/images/ directory allow the web server to write.
2. Open your browser and point it to your phpWebSite site.
3. Open the "Boost" module as an administrator or deity and select the "Uninstall" button for ArticleManager.
4. When asked if you are sure you wish to uninstall ArticleManager select "Yes".
--- NEW FILE: INTRODUCTION.txt ---
Introduction to Article Manager
===============================
The ArticleManager module lets you create dynamic web articles that display your site's content the way -you- want it to be displayed!
FEATURES
========
Custom articles - each section can look completely different
Define your own article and section templates
Admins can allow/deny ability to display external pages in an embedded frame
Users can add comments to your article
Users can view a list of the articles that they have created
Articles keep track of how many times they've been viewed
Articles can be set to start showing at a future date
Articles can expire on specified dates
Articles can be viewed in summary format with a link to the full article
MULTI-ARTICLE STORIES with automatic navigation controls!
Optimization: Images are stored in multiple directories for faster access
A library of approved images can be easily maintained
Images can be clickable links with alternate text and photo captions
Expired articles can be accessed from a list and re-activated
Module settings are easily changeable
User-submitted articles can require approval before activation
"Also on this site.." Block
"Previous n Articles" Block
"Most Popular Articles" Block
Articles can be set to not show up in the homepage summary listings
Articles can be assigned to topic categories
Articles can be viewed only by certain groups
All of your old Announcements & PageMaster Module content can be imported
Automatic rerouting of old mod.php, Announcements & PageMaster links
Display a printable version
Nothing is saved to disk until you hit "Save Page"
"Edit Locking" - Only 1 user can edit a page at a time
A "News" page that displays all articles
NOTE: The feature "Articles can be viewed only by certain groups" has been disabled pending the re-vamp of the FatCat module for phpWebsite version 0.93.
THE MAIN MENU
=============
The main menu is the nerve center of the entire module. It allows you to do four basic tasks -- list articles, create a new article, change Article Manager configuration settings and manage the Image Library.
LIST ARTICLES:
Here you can choose to view all approved articles on the site or just your articles ordered by Title or by the date of creation, publication, expiration, or the last update. This list can be viewed in ascending or descending order.
Each article in the listing is accompanied by buttons allowing you to set it as the homepage, edit it, delete it, or immediately publish or expire it. Of course buttons or options can only be seen if you are authorized to use them.
CREATE A NEW ARTICLE:
See the next section "CREATING & EDITING ARTICLES".
CHANGE CONFIGURATION SETTINGS:
We've made module customization easier for you by allowing you to change the following default settings:
The default page template
The default section template
The # of summaries that show up on the Home Page
The # of summaries that show up on article summary listings
The # of article listings that show up under the main menu
Whether articles need approval before publication
Whether articles can expire on a predefined date
Default expiration date offsets (years, months, days)
How many years in advance publication dates can be set
Uploaded image size limits (filesize, height, width)
Administrators can also decide whether users can:
upload images
include images in articles
add comments to articles
post comments without registering (Anonymous)
create new articles
edit/delete any, all, or just their own articles
choose when their articles expire
publish articles without admin approval
change the module configuration
Image Library Management
Instead of taking the security risk of allowing users to upload images to the server, admin-approved images can be stored in and selected from the Image Library.
After an image is uploaded to the library using the "Image Library Management" interface, it will appear on the list underneath that also gives you the opportunity to delete existing pictures.
CREATING & EDITING ARTICLES
===========================
Articles are basically made up of a title, article summary, and sections. Other information found on the article can include information on the author and the date created or edited.
TITLE:
All articles need titles! Enter one here.
SUMMARY:
Type in a SHORT description of the article here. When a list of articles is shown on the site, this will be displayed as a teaser to get the user to read more.
SECTIONS:
This is the meat of the article. A article can contain as few or as many sections as you like. When you create or start editing a article, all currently save sections are displayed as finished. After each section you will see buttons to edit that section or to move the section above or below its neighbors.
Near the bottom of the article a new blank section is created for you with its own "Save" button. See "Editing Sections" for a description of how they work.
CONFIGURATION OPTIONS:
Category:
The topic categories that this article falls under.
Allow Comments:
Whether users can add discussion or comments to this article
Allow Anonymous Comments:
Whether unregistered user can add comments (NOT RECOMMENDED!)
Publication Date:
A story can only be viewable on the site after it is published. You don't need to change this value. It is automatically set to the date this story was created. If you want this story to be invisible until a future date, then you can set it here.
Expiration Date:
A story can only remain on the site until it expires. You don't need to change this value. The site administrator has set a default period before stories expire. If you want this story to be deleted before or after this date, then you can set it here.
WHAT DO I NEED CATEGORIES FOR?
If this article is assigned to a category, ArticleManager can then work with other phpWebsite modules to group related articles together and give interested users suggestions on other articles to surf.
ARTICLE INFORMATION:
NOTE -- These items are not editable.
Created By: Who created the article
Updated By: the last person to edit the article
Created On: When the article was created
Updated On: When the article was last edited
Save Article:
Click this button when you're finished editing. If all information was entered in correctly, you'll be taken back to the main menu.
Creating & Editing Sections
Each section consists of a title and text (and sometimes an image). You can think of the title of a section as a subtitle of the article. Whenever you start editing a article or save a section, a new one is created for you.
START ON NEW PAGE:
This option enables multi-article stories. When enabled, this section will be the first of a new page.
TITLE:
Not necessary, but recommended. Enter the section title here.
TEXT:
Type in the section's text here. I'm not sure if there is a limit to how much text you can put here, but if you hit it, you'll know. Above this entry box is a text formatting bar that you can use to add html formatting to your text. You'll at least need to use the "new line" button to create line breaks.
IMAGE:
If you already added an image to this section, it's displayed here. If you are authorized, you will be given the options of uploading an image or selecting an existing image to display.
UPLOAD A NEW IMAGE:
This lets you upload an image that will be associated with this section. If you choose to use an image, you must also add a Short Image Description.
SELECT AN IMAGE FROM THE LIBRARY:
This site maintains a library of pre-approved images to use as an alternative to making, optimizing and uploading custom images. Just select the image you want to be associated with this section. If you choose to use an image, you must also add a Short Image Description.
ALTERNATE TEXT (Short Image Description):
REQUIRED! Enter a short description of the image that will display if a browser can't or won't show the image.
LINK:
Putting a link URL in here will turn the image into a clickable link.
LINK (PHOTO) CAPTION:
Sometimes you might want some text to appear above or below the image (eq: Photo Credits). Enter that text here.
CONFIGURATION OPTIONS:
Start on New Article: Whether this section starts a new article. See "MAKING MULTIPLE-ARTICLE STORIES".
Template : Choose a display format for this section.
SAVE SECTION:
Click this button when you're finished editing. If all information was entered in correctly, the article will re-display with the section in its proper place.
WHAT ARE TEMPLATES?
Each section can be displayed in a different way -- with an image on the left, right, above the text, with a different-colored title, or even with all the text centered on the article! This is all controlled by templates that the administrator creates. All you have to do is select which display format you want to use for this section. If you want to read about creating or changing templates, see TEMPLATES.TXT.
MAKING MULTIPLE-ARTICLE STORIES
===============================
Although webarticle content should always be as short and concise as possible, sometimes your article needs to be spread across more that one article. Usually when this happens we create several similarly-titled articles with links to related content:
How to Plan a Party: Getting Started
How to Plan a Party: Choosing the Place
How to Plan a Party: Picking the Music
How to Plan a Party: Get the Word Out
How to Plan a Party: Collect the Cash!
Lease Negotiation Tactics
How to get a DJ
Advertisement Media Effectiveness Statistics
Problem is, for each one of the "Planning the Party" articles, we have to create links to 4 other articles! What happens if we add a article? We have to add & change links in 6 articles!
ENTER ARTICLEMANAGER!
Whenever you want a section to start on a new page, just check the "Start on new page" box. ArticleManager will automagically divide your story into pages when it's displayed on your site. Each page's title will be the title of the first section on that page. So now your list of pages looks like this:
How to Plan a Party
Lease Negotiation Tactics
How to get a DJ
Advertisement Media Effectiveness Statistics
and when you click on "How to Plan a Party", the bottom of the pages will look like this:
Previous Page Next Page
Page 1: Getting Started
Page 2: Choosing the Place
Page 3: Picking the Music
Page 4: Get the Word Out
Page 5: Collect the Cash!
Since this is all basically one article, they will all have the same link (example:www.yoursite.com/index.php ?module=articlemanager &ART[view:article:2]). However, if you want to link directly to page 4 just add"&page_num=4" to the end of the url so it looks like this: www.yoursite.com/index.php ?module=articlemanager &ART[view:article:2]&page_num=4
If you click the Print Icon, the ENTIRE story will print out. Not just the current page.
COOL TIP!
If you want to see the entire article on one webpage, change the url to &page_num=all
--- NEW FILE: LICENSE.txt ---
EXPLANATION OF LICENSE (PREAMBLE):
==================================
I just wanted to take a second to explain my interpretation of the terms of this license so that there'll be no misunderstandings later on.
I'm new to this whole freeware thing. Frankly, I don't get how programmers can make money doing this. However, I'm willing to give it a shot. What I've done is inserted a copyright display of links that will show on every non-homepage generated by this module. I've made it really small so that noone but web spiders will really notice and use it.
Now that I've told you where to look, you can't stop staring at it, can you?
This copyright must always display so that it can perform its function. Since this module is released under the LGPL, you can change the code if you want, but this copyright must still display in the same manner. If you want to change or remove the copyright string, contact me and I will sell you a copy of this module under a different license.
These terms are covered in the license, but I understand that some folks choose to interpret the passage differently. For those people, let me make this clearer. Everything I just said is part of and supercedes the rest of the license terms specifed below. I'm not a lawyer, so if you feel that this invalidates the GNU license, then consider the above terms as constituting the entire license.
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
phpWebSite Modules
Copyright (C) 2003 Appalachian State University
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Appalachian State University, hereby disclaims all copyright interest in the
phpWebSite Modules library written by Appalachian State University.
--- NEW FILE: PAGE_INSERT_README.txt ---
README FOR PAGE_INSERT
George Brackett (gbr...@NO...)
5/27/03
--------------------------------
OVERVIEW
--------------------------------
Page_insert is a set of templates for use with the PageMaster module of
phpWebSite v 0.9+. These templates allow the insertion of any existing
web page within the framework of a phpWS site. They are based on the
showinmain module written for phpWS 0.8+ by Jim Flowers (jfl...@ez...).
The page insert capability should work for later versions of Internet
Explorer, Netscape Navigator, and Mozilla.
--------------------------------
INSTALLATION
--------------------------------
These templates should be installed within the theme directory for the theme(s)
you are using. That is, for every theme you are offering to users, you
should copy the three template files into the directory
themes/your_theme/templates/pagemaster/
This will make the page_insert templates available to the PageMaster module
when you are displaying the phpWS site using your_theme. Be sure to copy
the files to all the themes you are making available, or errors will result.
The three templates are as follows:
page_insert_fit_page.tpl - This template inserts the full page into the
pagemaster block. If the page being inserted is too large to fit
on-screen, the phpWS window will acquire a scrollbar at right.
page_insert_fit_block.tpl - This template inserts the page into the largest
possible scrolling area that will fit within the current-sized pagemaster
block.
page_insert_title_is_size - This template inserts the page into a scrolling
area of a fixed, specified height within the pagemaster block.
--------------------------------
USE
--------------------------------
After installing the templates in the theme(s) you wish to have the
page insertion capability, insert a page this way:
1. Log in as a user with PageMaster access. Select PageMaster.
2. Create a new page. Give it a title.
3. Edit the page.
a. In the first section, select one of the three page_insert templates
from the drop-down template menu.
b. If you chose page_insert_title_is_size, enter the height you want
for the scrolling page display in the Section Subtitle blank. For
example, to display the page in a scrolling area 500 pixels high,
enter 500 in the Subtitle blank.
c. Enter the URL of the page you want inserted as the text of the
section. The URL can be a full URL (i.e., http://mysite.com) or
a relative link to a file on your site (e.g., downloads/cool.html).
4. Save the section and the page.
That's it!
--------------------------------
HELP
--------------------------------
I have tested page_insert on IE 5 Mac and Mozilla 1.3 Mac. PLEASE email me at
the address above (without the NOSPAM, of course) if you find it DOES NOT WORK
with your browser. That way I can warn users of incompatibilities, or
find a fix.
--- NEW FILE: TEMPLATE.txt ---
Document - Templating with ArticleManager
Author - Adam Morton <ad...@ja...>
Author - Eloi George <el...@re...>
Updated - 12/5/2002
Templating in articlemanager is set up to allow administrators to create unique and flexible articles without too much hassle. To get started with templating it is recommended that you take a look at the default templates provided with articlemanager to get a feel for how they work. I will try to address further details in this document.
-------------------------------------------------------------------------------------------
TEMPLATE FILE PLACEMENT
-------------------------------------------------------------------------------------------
First off the placement of template files is very important. Template files can be stored in 2 places:
phpwebsite/themes/your_theme/templates/articlemanager/
-or-
phpwebsite/mod/articlemanager/templates/
Different template files are used in the display of various articles in ArticleManager. They can be found in subdirectories, you can identify them by the following naming scheme:
Article Edit Screen /templates/edit/article.tpl
Section Edit Screen /templates/edit/section.tpl
Summary Article Display Layout /templates/summary/default.tpl
Full Article Display Layout /templates/article/*/title.tpl
/templates/article/*/content.tpl
Section Display Layout /templates/section/*/title.tpl
/templates/section/*/content.tpl
I suggest that you copy this directory structure and store your templates under your theme directory. This will allow you to create different looks for each theme's web articles. However, if you find that you are simply copying your templates from one theme to another and not changing them, you may want to go ahead and dump your templates in the same type of structure under the articlemanager/templates/ directory.
Template files can be named anything you wish but they must be unique to the current theme. I would also suggest making them semi-intuitive so you know what the template is just by viewing the filename. The filename is used in selecting a template for a new section during article creation or editing.
-------------------------------------------------------------------------------------------
TYPES OF TEMPLATE FILES
-------------------------------------------------------------------------------------------
The article and section display templates are actually a set of different layouts you can choose from while designing your article. Each has a different display characteristic that is reflected in their names. These are the templates that come shipped with ArticleManager:
ARTICLE TEMPLATES
Blank
Byline
Dated
SECTION TEMPLATES
Centered Image
Image Block Left
Image Block Right
Image Wrap Left
Image Wrap Right
No Image
Text Only
If you create your own versions of these templates, I suggest that you use the same names but place them in the appropriate /themes/your_theme/templates/articlemanager/ subdirectory. This way if you change to a different theme, the basic design of your sections will be preserved!
-------------------------------------------------------------------------------------------
VARIABLES IN THE TEMPLATE FILE
-------------------------------------------------------------------------------------------
When creating a new template file or editing an existing one, keep in mind that the templates are used on a per section basis, not a per article basis. Variables in the template files are replaced with data pertaining to the current section being processed.
The usage of these variables is pretty simple, you surround the variable name with double brackets on each side and if the variable is recognized by articlemanager, it will replace it with the appropriate data. Here is an example:
{TITLE}<br />
{TEXT}
The above template will replace {TITLE} with the title for the current section being processed and {TEXT} with the text for the current section being processed.
Below are lists of variables that can be used in the various templates:
SECTION TEMPLATES
-----------------
IMAGE = The image for the current section.
CAPTION = The image caption for the current section.
TITLE = The title for the current section.
TEXT = The body text for the current section.
PRINT_ICON = A linkable image for a printable view of the current article.
The gif image for this icon must be stored in the "img" directory
and must be named "print.gif".
CREATED_DATE = The date the current article was created.
CREATED_USER = The username of the user who created the current article.
UPDATED_DATE = The date the current article was updated.
UPDATED_USER = The username of the user who last updated the current article.
FULL ARTICLE TEMPLATES
----------------------
TITLE = Page Title - Link to the full article
SUMMARYTEXT = Article summary
HITS = # of time article has been viewed
CREATED_DATE = Date article was creastred
UPDATED_DATE = Date article was last updated
EXPIRATION_DATE = Date article will expire
PUBLICATION_DATE = Date article was published (shown)
CREATED_USER = Author's name
UPDATED_USER = The last editor's name
CREATED_TEXT = "Created By: CREATED_USER on created_date
UPDATED_TEXT = "Last Updated By: UPDATED_USER on updated_date"
PRINT_ICON = Icon link to a printable version of the article.
The gif image for this icon must be stored in the "img"
subdirectory and must be named "print.gif"
BODYTEXT = The text of the current page of the article
NAVLIST = Linkable list of all pages within the article
NAVBAR = Linkable list of all page numbers within the article
PREV = Link to go to the previous page in the article
NEXT = Link to go to the next page in the article
EMAIL = Icon link to email the article to a friend. Not enabled yet
EDIT = Link to edit this article if user is authorized
DELETE = Link to delete this article if user is authorized
NUM_COMMENTS = # of comments on this article
CATEGORY = Shows icons for the categories that this article belongs to
ARTICLE SUMMARY TEMPLATE
------------------------
READMORE = "Read More" - Link to the full article
LINK = Link to the full article with no text
TITLE = Page Title - Link to the full article
SUMMARYTEXT = Article summary
HITS = # of time article has been viewed
CREATED_DATE = Date article was creastred
UPDATED_DATE = Date article was last updated
EXPIRATION_DATE = Date article will expire
PUBLICATION_DATE = Date article was published (shown)
CREATED_USER = Author's name
UPDATED_USER = The last editor's name
CREATED_TEXT = "Created By: CREATED_USER on created_date
UPDATED_TEXT = "Last Updated By: UPDATED_USER on updated_date"
PRINT_ICON = Icon link to a printable version of the article.
The gif image for this icon must be stored in the "img"
subdirectory and must be named "print.gif"
MOREWORDS = # of words in the article
MOREPAGES = # of pages in this article
EDIT = Link to edit this article if user is authorized
DELETE = Link to delete this article if user is authorized
NUM_COMMENTS = # of comments on this article
CATEGORY = Shows icons for the categories that this article belongs to
ARTICLE EDITITNG TEMPLATE
-------------------------
TITLE_LABEL = "Title:"
TITLE = Box for entering the title for the current article.
LINK_BACK = Clickable link back to the Main Menu
CATEGORY_LABEL = "Related Topics:"
CATEGORY = The FatCat category selection box
SUMMARY_LABEL = "Summary:"
SUMMARYTEXT = Box for entering the article summary text
SECTIONS = All sections for this article
INFORMATION_LABEL = "Article Information"
CREATED_TEXT = "Created By: created_username on created_date"
UPDATED_TEXT = "Last Updated By: updated_username on updated_date"
PAGE_SETTINGS_LABEL = "Article Settings"
COMMENTS_LABEL = "Allow Comments: "
COMMENTS_YES = Yes Selection Button
COMMENTS_NO = No Selection Button
ANON_LABEL = "Allow Comments by unregistered users:"
ANON_YES = Yes Selection Button
ANON_NO = No Selection Button
PUBLICATION_LABEL = "Publish on:"
PUBLICATION_DATE = Date selection boxes
EXPIRATION_LABEL = "Expires on:"
EXPIRATION_DATE = Date selection boxes
EXPIRATION_FLAG = Checkbox for whether this article can expire or not
PUBLICATION_TEXT = "Publication Date: publication_date"
EXPIRATION_TEXT = "Expires on: expiration_date"
TEMPLATE_LABEL = "Page Format:"
TEMPLATE = Selection box to choose which template to use
SAVE_WARNING = Reminder to save the Selection before you save the Article
SAVE_BUTTON = Self-Explanatory
CANCEL_BUTTON = Self-Explanatory
|
