README.txt
dbeall - October 19, 2009 - 07:21
| Project: | Boost |
| Version: | 6.x-1.x-dev |
| Component: | Documentation |
| Category: | task |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | closed |
Description
well, here I go, rewriting something the pros have written, please review, complain, hack, and/or comment.
Yep, you throw it back and I will work on it some more.
attached is a patch and a full text copy..
| Attachment | Size |
|---|---|
| new_readme.txt | 12.79 KB |
| rewrite_readme.patch | 17.35 KB |
#1
added note: I put at least 1(one) space in front of every line to keep all text off of the left margin.
#2
Thanks for doing this so quickly!
Minor changes, everything else looks good!
INSTALLATION
4. Default install dir is now cache/normal/www.example.com; gzip is in the same dir.
7. This is more of an advisory, not an absolute... might be better if it was located in a troubleshooting area. Thoughts?
HOW BOOST WORKS
Spelling error with the last word of this section; but this doesn't matter since this is incorrect:
or the cached copy is stale(exspired). Even if the cached file is expired, if it exists it will be served. Looks like wishful thinking on the part of the previous writer of this readme file.New rewrite rules are added to the .htaccess file supplied with Drupal,directing the web server to try and fulfill page requests by anonymous
visitors first and foremost from the static page cache, and to only pass the
request through to Drupal if the requested page is not cacheable or has yet
to be cached.
FILE SYSTEM CACHE
Needs the _ at the end of the file.
http://mysite.com/
=> cache/mysite.com/_.html
http://mysite.com/about
=> cache/mysite.com/about_.html
http://mysite.com/about/staff
=> cache/mysite.com/about/staff_.html
http://mysite.com/node/42
=> cache/mysite.com/node/42_.html
LIMITATIONS
remove the windows part, it works on windows.
#3
will give it an update, thanks for the quick response.
I rewrote the whole node_gallery (module text t'strings') and still haven't had a reply after days.. Your on it!
#4
updates:
added a few small things:
changed a few things:
re-order items:
Drupal forum 22 link
System Check & Verify Functions
Important Notes & Troubleshooting
mysite.com > example.com
#5
I could probably add a lot to this.. lol, you know how that is.
My day is 23 hours old > going to sleep.. will check in when the coffee is on and play with htaccess then too.
EDIT: Note to self about file path for gzip:
6.x-1.13 UI shows cache/normal.. but (m2) said it's the same for gzip, meaning cache/gz ?
EDIT info 4 today OCT19th 4pm: rework readme, add more stuff, break it down.. working on providing new update for comment.
#6
today's version, did not have everything from cvs on last patch.
more stuff in this version, Boost blocks
--Still don't have retrieve from cvs figured out yet...
EDIT: SCRATCH this file.. forgot something... sorry
#7
ok, this should be better.
(was busy fighting with wamp(locked up) and got side tracked..)
note: the reason for 1(one) space from left margin is for Advanced Help module and viewing this on a web page.
please review and advise.
#8
RECOMMENDED MODULES
Just thought of this: If using cck node reference then the cck node referrer module is recommended.
INSTALLATION
The default is
cache/gz/www.example.comcache/normal/www.example.com.This change makes life easy and works for 99% of site out there, it's rare they hit 100k+ files in a single directory. Makes FTP del much simpler, ect...
BOOST ADMINISTRATIVE AND STATS BLOCKS
Probably should mention that you can further control the blocks by configuring "Show block for specific roles:"
FILE SYSTEM CACHE
cache/normal/example.com/index_.htmlcache/normal/example.com/_.html#9
changes made, anything else..
I wish advanced_help supported full html so the links were 'clickable'.
#10
scratch that one.. one more correction for gz directory
#11
trying to see what Boost produces in the cache file system
on wamp with latest dev(oct 18th) downloaded today.. after Boost enable, it gives me one more page.. boost settings, then it locks up and will not do anything..
can there be a new bug here?
#12
Works on my local xampp install... anything else you can give me for debugging?
#13
I wish I could. It is a working fresh drupal install. all the other installs will open. but that one locks up wamp. have to clear all browser cache to get wamp/localhost back.
i have been running all the previous boost releases with no issues.. i don't know. maybe i will stick xamp in and try that.
#14
I am trying to figure out how to clear the wamp error logs for new test
#15
Fatal error: Maximum execution time of 120 seconds exceeded in C:\wamp\www\Drupal6\sites\all\modules\boost\boost.module on line 3086
#16
php.. log
[19-Oct-2009 20:07:59] PHP Warning: Module 'curl' already loaded in Unknown on line 0
#17
line 3086 is boost_async_opp()
<?phpwhile (ob_get_level()) {
ob_end_clean();
}
?>
Means something with output buffers is up... like you have a lot of them or I can't break out. Maybe I should limit this to something like 25 tries in the while loop.
I don't load curl in boost, so thats odd.
#18
the curl is previous in the log.. probably not the issue..
[19-Oct-2009 20:07:59] PHP Warning: Module 'curl' already loaded in Unknown on line 0
[19-Oct-2009 20:07:59] PHP Warning: Module 'curl' already loaded in Unknown on line 0
[19-Oct-2009 20:07:59] PHP Warning: Module 'curl' already loaded in Unknown on line 0
[19-Oct-2009 20:07:59] PHP Warning: Module 'curl' already loaded in Unknown on line 0
[19-Oct-2009 20:10:34] PHP Fatal error: Maximum execution time of 120 seconds exceeded in C:\wamp\www\Drupal6\sites\all\modules\boost\boost.module on line 3086
#19
#609030: Limit # of tries in the boost_async_opp() while loop
#20
ok, got that fixed, all that for my own 'show me' what it does..
ahhh, back on track.
few more changes, some spacing fix gz directory stuff...
add Node Referrer
note about block visibility
#21
Looks Good! Thanks again for your help!
#22
committed
#23
I always check things once before looking away...
CREDITS
-----------
The URLs do not show using Advanced Help module, (due to < ... > enclosing URLs.)
I never took those out from old readme, it's always something. I had no idea that hides them.
patch applied to 6.x-1.13 README.txt
#24
remove the < > around the website links in the credits section, correct?
#25
HOLD ON for a second..
after a test, I am redoing all the URLs to
<a href="http://316solutions.net">316solutions</a>If they are done in normal html format, they are clcikable links
#26
yes, those hide the link text
but if they are html, they ""work""
#27
now, i am thinking they should all be (target="_blank") to keep the admin window active using advanced help
#28
now i don't know... if using as a readme file, it will look like crap
#29
Keep it simple, assume people use the middle mouse button when opening up a link.
#30
darn it..
how about a way to have a file for advanced help that uses html LINKS
Using & Blogging About Boost
and a readme.txt that has plain text as now.
Using & Blogging About Boost-- http://drupal.org/node/546834
I am so dam picky...
#31
I never knew you could do that until right now.. I love my 9 button logitec mouse
#32
Here's hook_help
<?php/**
* Implementation of hook_help(). Provides online user help.
*/
function boost_help($path, $arg) {
switch ($path) {
case 'admin/help#boost':
if (file_exists($file = drupal_get_path('module', 'boost') . '/README.txt')) {
return '<pre>' . implode("\n", array_slice(explode("\n", @file_get_contents($file)), 2)) . '</pre>';
}
break;
case 'admin/settings/performance/boost':
return '<p>' . t('') . '</p>'; // TODO: add help text.
}
//hack to get drupal_get_messages before they are destroyed.
$GLOBALS['_boost_message_count'] = count(drupal_get_messages(NULL, FALSE));
}
?>
Putting something other then README.txt in there would be very easy to do
#33
The advanced help module allows module developers to store their help outside the module system, in pure .html files.
http://drupal.org/project/advanced_help
#34
so leave the readme, correct the <>
and write an enhanced help .html file for the advanced help module ..
yipee, now we have "back to top" and contents targets....
#35
ok will remove < > and look at the advanced help examples for guidance in this matter. Go ahead and create a new issue for integration with the advanced help module.
#36
committed
#37
Automatically closed -- issue fixed for 2 weeks with no activity.