The Joomla! Forum ™

Hello. I'm Alesandro and I'm a fifteen year old freelance web developer and entrepreneur. My areas of expertise are PHP (specifically PHP5 OOP), XHTML (yes, I code in Strict), CSS, JS, HTML, some C and C++, Flash, ActionScript, etc...

I will be posting a draft of the document within the next couple of days (maybe later tonight?) for review. Hope my work is useful for the community!

(I have claimed the task under Google Account "k00lstuffks")

*Start Issue Description*

One line summary
Create a two-page document entitled "Create a two-page document entitled
"Creating a Custom 404 page"

Description
Download and install Joomla! using the Joomla! Installation Guide. Using
the instructions provided in this and the next Joomla! forum post, document
how to create a custom 404 page for a Joomla! v 1.5 website. Provide screen
shots and detailed, step by step instructions of the process.

Documentation written for this task must be made available under the
Joomla! Electronic Documentation License.

Skills Needed
Ability to use install a local host environment. Ability to review software
and identify features. Good Open Office and writing skills.

Difficulty
Basic.

Work Product
Attractive, correctly written white paper. Use logo and color scheme.

Time Limit
1 week

*End Issue Description*

Well, Jedi (we already have a famous one, Leolam), thanks for joining and... we will be waiting for your first draft

Have you read the phpgacl documentation? 

_________________
...nam qui dabat olim imperium, fasces, legiones, omnia, nunc se continet atque duas tantum res anxius optat, panem et circenses...
http://www.todosjuntos.org
http://inmo-e.com

Here are a couple of links to get you started.

Also, this is a two-week task, not a one week task.

# http://www.developer.joomla.org/wiki/System_error_pages
# http://www.developer.joomla.org/wiki/Custom_error_pages

Please take time, every few days, to check in and review your drafts with the community. That way, we can help answer your questions or direct you to good information needed to help you be successful with your task. This contest has been underway long enough, now, that we can certainly see better results come from closer interaction with the community. So, be certain to take advantage of that!

Look forward to reviewing your work,
Amy

_________________
http://Twitter.com/AmyStephen
http://www.alltogetherasawhole.org/

I took some time off before my birthday party to work on the documentation. I've already got the outline of the document in my mind, and I'll start writing after the party. The document will probably include:

• What is an error 404 page?
• How to customize your Joomla! error pages

              -Includes how to keep visitors from leaving + other tips

• Error pages outside of Joomla!

There's probably some things missing on the list, since I had it in an unsaved document (yeah, I know... always save periodically) last night when the power went out (new UPSes arrived this morning -- kinda late ).



I'm assuming this document will be part of the Joomla! User Guide, so I'll be using the same color scheme used in the v1.5 Installation Guide PDF, but I have no clue where I should use the logo. (Maybe I'll find the answer on the Joomla! Editorial Style Guide, which I've started reading.)

I'm trying to have a rough draft done between Thursday and Friday for the community to review.

Thanks,
Jedi

Edit: I have already installed RC4 and noticed the error template structure has changed from individual error files (404.php, 403.php, etc) to one error.php file. It's a good move, and I'll write the document to reflect these changes. If by the time I'm done with the task the wiki hasn't been updated, I will take care of that too.

So, this is just a lie? You're not really 15? What else is a lie? Are you really, Alesandro? 


Happy 16th Birthday, Jedi!

Amy

_________________
http://Twitter.com/AmyStephen
http://www.alltogetherasawhole.org/

hehe, thanks! The cake is not a lie though.

Also check the edit I made to the post... you seem to have posted just as I was editing it.

(Also answer my question on the previous post... *pokes Amy*)

Woo! First draft is ready! I've put in everything I can think of regarding error pages. I haven't proofread it yet, but I will do after I take a break.

I'll be waiting for feedback from the community! (although I haven't seen anyone else post in this thread, except ibnhafsun)

Version 0.1.3
http://ecocubetech.com/tpj/ghop/joomla/creating_a_custom_404_page.odt

Sometimes you use Halvetica, and sometimes you use Georgia.

Also, sometimes file names are in quotes and sometimes they aren't.


This could be better worded as: "This document shows you what 404 error pages are, and how to customize them to reference other pages and keep visitors on your site."


You should explain how to do this. 



Or, what you may want to do is move these to a section at the bottom that says:
"If you would like to report this problem to an administrator (mailto:admin@yoursite.com) and give them these details:"
You then move $this->error->message, etc. here.  It is probably not a good idea to remove this stuff, because this will tell the admin what is wrong.

_________________
Leonard Bernstein for President -
Web Development Services: www.BernsteinForPresident.com
My Software Freedom Blog: Trombonechamp.Wordpress.com

Change log:

• Added "how to backup error.php/error.css" in caution areas
• Added single quotes on all file names and directory locations
• Fixed inconsistencies in font faces
• Modified document summary
• Modified "Removing Technical Details" (Also renamed to "Moving Technical Details")

I have no idea why I wrote the 'reference' part... I modified the line to say "This document shows you what 404 error pages are, how to customize them, and how to keep visitors on your site."


Great suggestion. I wrote that part in a hurry and didn't really think of that.

Here's v0.1.7...
http://ecocubetech.com/tpj/ghop/joomla/ ... _0.1.7.odt

Who is your audience?  If it is newbies, you might want to include the command for unix-based machines to back up that file.  I am pretty sure Windows servers still run the GUI, but for unix servers, you need to type
in the directory to back up a file.  If you want to mention how to restore it, it is just the opposite:

If you are writing this for more experienced admins, it should be fine as it is.


Since most of the people here will be using Apache or IIS (possibly even lighttpd), it may be a good idea to include instructions for these servers, and then say "if you use something else, go find help elsewhere."  At the least, you should probably link to some pages that do this for Apache, IIS, and lighttpd.


This is really good!!!

_________________
Leonard Bernstein for President -
Web Development Services: www.BernsteinForPresident.com
My Software Freedom Blog: Trombonechamp.Wordpress.com

The audience will probably be novice-intermediate users... I could add the command, but I'm sure newbies know how to copy files anyways (I could add the line, just don't think it's really necessary -- more input from community + word from reviewers requested)
Also I'm a linux user (no, not an ubuntu user), so I know my CLI but thanks for putting in the commands anyways


I think linking should be better, but idk what is the "policy", if you will, on external linking on documentation for Joomla!... I thought about linking, but then I had the concern of outdated links being in the docs.. but then again, writing it in the docs would end up in the same situation... eventually outdated information.


Thanks
I'm not usually a good writer, but apparently I'm pretty good writing documentation


Can someone verify this? I know that in Joomla! 1.5 RC3, the scheme described above was used, but idk if it was really used in Joomla! 1.0... I just assumed it was at the moment of writing.



Possible changes:

• Add commands to copy files in Unix-based systems
• Adding links to Apache, IIS, etc. docs for customizing error pages.
• Correction of Joomla! 1.0 reference information.

I'll be away from Monday afternoon until Tuesday night or Wednesday. Happy Holidays!

Yes, scrap the unix command.  Those people are expected to know how to use their server.


Yay!  Another GNU/Linux user!  Even on these forums you don't find many of those!


Other people have linked to Joomla! forum entries, but this could be the "Pingus effect"


I know I have a 404.php in my installation of Joomla! 1.0, but I don't have any other error numbers. 

_________________
Leonard Bernstein for President -
Web Development Services: www.BernsteinForPresident.com
My Software Freedom Blog: Trombonechamp.Wordpress.com

I don't see a /templates//css/error.css or /templates//error.php file.

What am I missing? I wonder if that is old documentation? Or, is there an example error.php file we can copy from somewhere to get started?

I'm going to have to ask around. I originally proposed this task and used a thread I was in for the example. But, these links were added - I assumed by the documentation folks. My suggestions were a "work around" since I did not see any other solution.

But, I believe you are talking about files that I do not see existing. So, we might need more information. Do you know where those files are?

We'll figure it out. Now, do you understand how important this work is? This is a valuable document. Thank you for taking this task for our community.

Amy

_________________
http://Twitter.com/AmyStephen
http://www.alltogetherasawhole.org/

Mine is only in the "system" directory.  I don't think all templates specify error pages, and just use the default.

_________________
Leonard Bernstein for President -
Web Development Services: www.BernsteinForPresident.com
My Software Freedom Blog: Trombonechamp.Wordpress.com

I noticed that, too. I also tried to navigate to a URL within my site that does not exist. That resulted in an error message "Notice: Undefined index: option in D:\VirtualWebsites\JoomlaPlace\JoomlaGHOP\includes\router.php on line 226." I do not believe the error.php file was used.

Need more info...

_________________
http://Twitter.com/AmyStephen
http://www.alltogetherasawhole.org/

We are talking with a developer on this.

_________________
http://Twitter.com/AmyStephen
http://www.alltogetherasawhole.org/

I think I got the Joomla! standard error page.  It looks like the picture I uploaded.  It only happens when you pass an article number to index.php that doesn't exist.  For example, this url:

If you go to a page that doesn't exist, you get the standard 404 page.

_________________
Leonard Bernstein for President -
Web Development Services: www.BernsteinForPresident.com
My Software Freedom Blog: Trombonechamp.Wordpress.com

Thanks, Max. I should have been specific as the problem is with SEF URL pages. In particular, the SEF URL option absent index.php (so 2nd and 3rd.)  But, you are right in that this can be documented using that testing. Then, hopefully, the bug will be figured out..

Thanks for all you do, Max.

Amy

_________________
http://Twitter.com/AmyStephen
http://www.alltogetherasawhole.org/

Well I'm back a bit earlier I see a lot of posts, so I'm going to read them carefully and reply!


I'll add in the links in the next revision.


Thanks for verifying.




That is very true... I now noticed not all templates have an error.php and error.css file included. I'll need to add to the document how to copy these files from /templates/system/error.php and /templates/system/css/error.css into their template's folder and then proceed, if necessary.
Also regarding "old documentation", I'm writing this document from viewing the file structure and Joomla!'s behavior, not from previous documentation, since it is probably outdated (anyways, I have not found previous documentation on custom error pages for Joomla!).


I am realizing how important this is, because when I Google "Joomla custom 404" or "Joomla custom error page", and variations of these, I cannot find any actual guide on doing this for Joomla!. This document is also very important since old documentation for Joomla! 1.0 wouldn't apply to Joomla! 1.5 due to the changes in file structure for error pages.





I didn't take into consideration SEF URLs... I'll experiment more with Joomla!'s SEF URLs and see if it is possible to use the template's error pages... (maybe using the code Amy posted on another thread, but that involves editing of the template source files)

Please let me know if there is any other way for Joomla! to also use error.php when using SEF URLs.



For the next revision...

• Adding links for Apache, IIS, etc. instructions on customizing error pages.
• Adding notes to copy files from System template if not provided by template.

And after publishing the next revision, going to experiment with SEF URLs error pages. Any extra info on this is welcome!

Well, I see I have plenty of work to do in the morning! Happy Holidays!

I wonder, do they have to copy these into their own template folder? I need to do some experimenting of my own. In the Milkyway template, the system.css is linked to:


The application routes to the templates/system/error.php file with errors. I don't know if you can copy that file into your template folder to override the existing one. Might want to test that theory. (Maybe you have already tested it. I have not.)


For now, do not document that work around method I posted. I hope that the SEF URL 404 issue is resolved as a bug. Since I was able to figure out a 404 in the template using the ItemID, this certainly can be fixed in the appropriate place in the router. We have developer attention on it and the problem will be (or has been) added to the tracker. We will continue to work with the developers on this and get back to you. For now, assume it works for all types of URLs and document the non-SEF URL. (specially, avoid the SEF URL without index.php)


No reason to add any Apache or IIS error pages. Most end users do not have access to the web server configuration, anyway, and it is outside the scope of Joomla!. There are better sources of that than us. Let's instead stick with the error.php file and the various errors it is able to show.

Thanks!
Amy

_________________
http://Twitter.com/AmyStephen
http://www.alltogetherasawhole.org/

Uh... copying system.css won't do much.... I 'm not sure where that is used, but it's not in the error.php file. It's probably best to copy error.php and error.css files into your template folder, instead of editing the System template, as this can be used for backups, etc... (probably shouldn't be tampered with anyways)


Alright. It's better to have it fixed in the core than add possibly buggy and unreliable workarounds.
If necessary, before final release of the doc, add a note saying that this procedure will not work for SEF URLs. Hopefully by then the core will be modified accordingly to issue this bug, though!


Alright, I won't modify this section.



Change log:

• Added note regarding 'error.php' and 'error.css' files not being in template directory.
• Changed some words for more smoothness and understanding.
• Replaced first 'error.php' screenshot with new screenshot in 'Changing Visual Styles' section.

Version 0.2.0
http://ecocubetech.com/tpj/ghop/joomla/ ... _0.2.0.odt

Edit: Corrected version number

Just wanted to acknowledge my presence... I was away on a three day vacation; arrived earlier today.

Happy Holidays!

(P.S. my task is due on Monday Dec 31st... waiting on community feedback for v2.0)

OK. I've been trying to get the SEF URL 404 issue resolved, but it might take a bit longer.

I'm very pleased with this work. Please upload it to your Google Task page and I will close your task.

Thanks very, very much for your contribution to the Joomla! community!

This task is complete.
Amy

_________________
http://Twitter.com/AmyStephen
http://www.alltogetherasawhole.org/

Alright. Thank _You_!

I posted the document on the GHOP task page @ http://code.google.com/p/google-highly- ... tail?id=88

Hope you guys get the SEF issue resolved before final release

Again, thanks. It's been a pleasure contributing to an Open Source project I'm sure to take on another task as soon as possible!