[Phpslash-commit] CVS: phpslash-ft/doc/html phpslash.sgml,1.9,1.10
Brought to you by:
joestewart,
nhruby
Menu
▾
▴
[Phpslash-commit] CVS: phpslash-ft/doc/html phpslash.sgml,1.9,1.10
|
From: Joe S. <joe...@us...> - 2001-12-28 21:55:04
|
Update of /cvsroot/phpslash/phpslash-ft/doc/html
In directory usw-pr-cvs1:/tmp/cvs-serv4430/phpslash-ft/doc/html
Modified Files:
phpslash.sgml
Log Message:
docs - early, rough upgrade guide
Index: phpslash.sgml
===================================================================
RCS file: /cvsroot/phpslash/phpslash-ft/doc/html/phpslash.sgml,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** phpslash.sgml 2001/11/24 15:05:05 1.9
--- phpslash.sgml 2001/12/28 21:55:01 1.10
***************
*** 465,469 ****
<sect>Upgrade
! <sect1>From versions earlier then 0.6
<p> Versions of phpSlash greater than 0.6.2 <bf>will not</bf> support
upgrading a 0.5.x install. You will manually need to upgrade to 0.6.2 and
--- 465,469 ----
<sect>Upgrade
! <sect1>From versions earlier than 0.6
<p> Versions of phpSlash greater than 0.6.2 <bf>will not</bf> support
upgrading a 0.5.x install. You will manually need to upgrade to 0.6.2 and
***************
*** 500,504 ****
</code></tscreen>
! <item> Since your upgrading from 0.5 we need to make some changes to the
DB so it will handle the BIG numbers so run the slash5to6.sql file too:
--- 500,504 ----
</code></tscreen>
! <item> Since you're upgrading from 0.5 we need to make some changes to the
DB so it will handle the BIG numbers so run the slash5to6.sql file too:
***************
*** 559,562 ****
--- 559,685 ----
</itemize>
+ <sect1>From versions 0.6x to 0.65
+ <p> Versions of phpSlash greater than 0.6.2 <bf>will not</bf> support
+ upgrading a 0.5.x install. You will manually need to upgrade to 0.6.2 and
+ then upgrade from that point on. The reason for this is that the
+ database schema in 0.6x radically changed from 0.5x and supporting that
+ particular upgrade path is just not feasible or viable given the number of
+ developers we have.
+
+ <sect2>Before you begin
+
+ <P>
+ <itemize>
+ <item> Install phpslash 0.65 in a new directory and set all the path
+ related variables as documented in the INSTALL file. Oh yeah, copy over
+ any special logos or topic images that you will need from the old slash
+ directory to the new one.
+ </itemize>
+
+ <sect2>The Upgrade
+
+ <p>
+ <enum>
+ <item> It would be a good idea to backup the database at this point:
+
+ <tscreen><code>
+ mysqldump slash > slash-backup.sql
+ </code></tscreen>
+
+ <item> Since you're upgrading from 0.6 we need to make some changes to the
+ DB so run the tables/0.65/6_to_65.sql file:
+
+ <tscreen><code>
+ mysql slash < 6_to_65.sql
+ </code></tscreen>
+
+ <p>
+ <bf>STOP IF YOU GOT ANY ERRORS, YOU NEED TO FIX THEM BEFORE YOU
+ CONTINUE. ASK THE MAILING LIST QUESTIONS IF YOU NEED HELP!!!</bf>
+
+ <item>Customize templates. Many templates changed since the release of 0.6,
+ so simply copying the templates from the 0.6 installation will not work.
+ Instead of modifying the files in the "default" directory, it may be better to
+ copy the entire contents of the "default" directory to another directory.
+ Then customize these files.
+ The default template/skin location is specified in config.php3 on this line:
+
+ <tscreen><code>
+ $_PSL[defaultskin] = "default";
+ </code></tscreen>
+
+ <item>This is a list of template files that are new or changed since the
+ release of 0.6:
+
+ <tscreen><code>
+ about.tpl
+ article-pf.tpl
+ articleEmailBody.tpl
+ articleEmailSent.tpl
+ authorList.tpl
+ authorNew.tpl
+ backendBlock.tpl
+ backendHTML.tpl
+ backendJS.tpl
+ backendJSData.tpl
+ backendMozilla.tpl
+ backendOpml.tpl
+ backendRSS1.tpl
+ backendRSS91.tpl
+ backendRSS92.tpl
+ backendTxt.tpl
+ backendWml.tpl
+ comment.tpl
+ commentDisplay.tpl
+ commentIndex.tpl
+ commentSubmitForm.tpl
+ fancybox.tpl
+ glossarySearch.tpl
+ index.tpl
+ index3col.tpl
+ loginform.tpl
+ loginformCR.tpl
+ mailinglistForm.tpl
+ mailinglistMessageForm.tpl
+ messageStrike.tpl
+ pollDisplay.tpl
+ pollEdit.tpl
+ pollList.tpl
+ pollMoreLink.tpl
+ pollResultPage.tpl
+ pollShow.tpl
+ searchPage.tpl
+ skinsblock.tpl
+ slashHead.tpl
+ story.tpl
+ storyList.tpl
+ storyNew.tpl
+ storyRelated.tpl
+ submissionList.tpl
+ topicsblock.tpl
+ </code></tscreen>
+
+
+ </enum>
+
+ That should be it. If you get any errors, then send an email to the list
+ and we'll try to help out as best as we can.
+
+ <sect2> Troubleshooting
+ <p>
+ The new site isn't *perfect*. Here are some things that you'll need to
+ manually adjust:
+ <itemize>
+ <item> The poll block may not be correct. Go to the poll Admin screen and
+ select the poll that you want to show up and make it the "current" poll
+ again. That will do it.
+
+ <item> All of the variables in the database have been phased out.
+ All the variables that are related to presentation (bgcolor,font color,
+ font size...) have been removed and placed in the templates. That's where
+ you should do all your presentation customization.
+ </itemize>
+
+
<!-- SECTION START: User Documentation -->
<sect> User Documentation
***************
*** 894,903 ****
<tscreen><verb>
<!-- start of sampleTemplate.tpl -->
! <p> Hello {PERSON}! This is a sample template! </p>
<!-- end of sampleTemplate.tpl -->
</verb></tscreen>
! In this case {PERSON} is a placeholder and will be replaced with whatever
! text the template engine has been given for the keyword PERSON. The result
that will be printed back top the browser (assuming you gave the code a
name of "Joe Sixpack") would be:
--- 1017,1025 ----
<tscreen><verb>
<!-- start of sampleTemplate.tpl -->
! <p> Hello {PERSON}! This is a sample template! </p>
<!-- end of sampleTemplate.tpl -->
</verb></tscreen>
! In this case {PERSON} is a placeholder and will be replaced with whatever text the template engine has been given for the keyword PERSON. The result
that will be printed back top the browser (assuming you gave the code a
name of "Joe Sixpack") would be:
***************
*** 917,921 ****
<tscreen><verb>
<!-- BEGIN testBlock -->
! Some stuff with a {PLACEHOLDER} that will be repeated
<!-- END testBlock -->
</verb></tscreen>
--- 1039,1043 ----
<tscreen><verb>
<!-- BEGIN testBlock -->
! Some stuff with a {PLACEHOLDER} that will be repeated
<!-- END testBlock -->
</verb></tscreen>
***************
*** 938,942 ****
The following files will get the look of your site changed pretty quickly,
! though there are a lot more in the $templatedir directory. You may need
to edit some of the more obscure ones if you are making radical changes to
the site layout.
--- 1060,1064 ----
The following files will get the look of your site changed pretty quickly,
! though there are a lot more in the template directory. You may need
to edit some of the more obscure ones if you are making radical changes to
the site layout.
***************
*** 982,989 ****
footer, appends the phpslash copyright, and closes the HTML page.
! This files is what ends every page. If you open any tags in slashHead.tpl
remember to close them here.
</descrip>
<!-- START SECTION: FAQ -->
--- 1104,1212 ----
footer, appends the phpslash copyright, and closes the HTML page.
! This file ends every page. If you open any tags in slashHead.tpl
remember to close them here.
</descrip>
+
+ <sect1>Complete list of templates and short descriptions:
+ <p>
+ <tscreen><verb>
+ about.tpl - About page
+ admin.tpl - deprecated
+ article-pf.tpl - printer friendly article page
+ article.tpl - article page
+ articleEmailBody.tpl - email article to a friend form
+ articleEmailForm.tpl
+ articleEmailHeaders.tpl
+ articleEmailSent.tpl
+ articleEmailSubject.tpl
+ articleEmailToAddress.tpl
+ authorList.tpl - list of authors in authorAdmin
+ authorNew.tpl - manage authors in authorAdmin
+ backendBlock.tpl - %% delimited text
+ backendHTML.tpl - fancybox
+ backendJS.tpl - javascript [untested]
+ backendJSData.tpl - javascript array [untested]
+ backendMozilla.tpl - Mozilla Sidebar
+ backendOpml.tpl - Userland's Outline Processor Markup Language [untested]
+ backendRSS1.tpl - RSS 1.0
+ backendRSS91.tpl - RSS 0.91
+ backendRSS92.tpl - RSS 0.92
+ backendTxt.tpl - text
+ backendWml.tpl - WAP Wireless Markup Language [untested]
+ blockEdit.tpl - manage blocks in blockAdmin
+ blockList.tpl - list blocks in blockAdmin
+ breadcrumb.tpl - display current section and topic
+ calendar.tpl - calendar block
+ comment.tpl - all comments and the mode change form
+ commentDisplay.tpl - individual comment format
+ commentFlat.tpl - flat view
+ commentIndex.tpl - index of comment subjects
+ commentNest.tpl - nested comments
+ commentSubmitForm.tpl - add a comment form
+ error.tpl - display error message
+ fancybox.tpl - blocks
+ footer.tpl - unused
+ glossaryList.tpl - list of glossary entries in glossaryAdmin
+ glossaryNew.tpl - manage glossary entry in glossaryAdmin
+ glossarySearch.tpl - glossary display
+ header.tpl - unused
+ index.tpl - index page
+ index3col.tpl - three column example index page
+ infolog.tpl - infolog management in infologAdmin
+ loginform.tpl - login form
+ loginformCR.tpl - login form using Challenge-Response [default]
+ mailinglistAdmin.tpl - manage Mailing list
+ mailinglistForm.tpl - subscription form
+ mailinglistList.tpl - subscribers list
+ mailinglistMessage.tpl - message format
+ mailinglistMessageBody.tpl - message format
+ mailinglistMessageForm.tpl - manage Mailing list
+ mailinglistSubscribe.tpl - subscribe confirmation text
+ mailinglistUnsubscribe.tpl - unsubscribe confirmation text
+ messageStrike.tpl - used to strike out text that is not translated.
+ navbar.tpl - top Navigation bar (Home, About, etc.)
+ navbarFooter.tpli - bottom Navigation bar (Home, About, etc.)
+ pollAdminLink.tpl - links to administer polls
+ pollDisplay.tpl - voting form and comment display
+ pollEdit.tpl - create or edit poll
+ pollEditLink.tpl - link to administer poll
+ pollList.tpl - list of polls
+ pollMoreLink.tpl - link to more polls
+ pollNewButton.tpl - link to new poll form
+ pollResultPage.tpl - show poll results
+ pollShow.tpl - show poll results
+ queryblock.tpl - format of query block contents
+ quoteblock.tpl - format of quote block contents
+ searchMatch.tpl - each search result
+ searchMoreMatches.tpl - link to more search results
+ searchNoMatch.tpl - text for no search results
+ searchPage.tpl - search page layout
+ searchPrevMatches.tpl - link to previous search results
+ sectionList.tpl - list of sections in sectionAdmin
+ sectionNew.tpl - new section form
+ sectionsblock.tpl - format of section block contents
+ skinsblock.tpl - format of skins block contents
+ slashFoot.tpl - footer
+ slashHead.tpl - header
+ story.tpl - story portion of article page and possibly index page
+ storyIndex.tpl - stories portion of index page
+ storyList.tpl - list of stories in storyAdmin
+ storyNew.tpl - manage story in storyAdmin
+ storyRelated.tpl - related links
+ submission.tpl - view of submission
+ submissionForm.tpl - add a submission
+ submissionList.tpl - list of submissions in submissionAdmin
+ submissionNew.tpl - manage submissions in submissionAdmin
+ titlebar.tpl - story titles and admin functions
+ topicBar.tpl - display of topics in header
+ topicList.tpl - list of topics in topicAdmin
+ topicNew.tpl - manage topic in topicAdmin
+ topicsDisplay.tpl - list of all images in topics directory
+ topicsblock.tpl - format of quote block contents
+ variableList.tpl - deprecated
+ variableNew.tpl - deprecated
+ </verb></tscreen>
+
<!-- START SECTION: FAQ -->
|
