110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Google's Highly Open Participation Program tries to get young students into Open Source and Joomla! specifically. Everyone is welcome, there are not limits. You can be a coder, documenter, tester, translator to help out. Jump in and start helping!
Locked
Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Wed Dec 05, 2007 12:53 pm

My Name is Benjamin Hättasch. I'm using Joomla for myself for quite a long time and now wanted to take part in this Contest - so I took a Joomla! Issue.
Issue 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"
Description
Show how to enable SEF URL options in the backend Administration Global
Configuration utility on the System Configuration tab. Demonstrate no
options, and each option incrementally, presenting examples of how the URL
changes. Show how to create an .htaccess file using the default
htaccess.txt file provided.

Also, explain How to configure Apache for Rewrites and how to test if
rewrites are working by adding this to the .htaccess file and navigating to
your site:

RewriteRule (.*) http://www.google.com/

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

Skills Needed
Ability to install XAMPP, download and install Joomla! on a localhost using
default data. Ability to review software and identify features. Good Open
Office Writer and communication skills.

Difficulty
Basic

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

Extra Credit (optional)
Show what the URL will be for each of Joomla!'s core components. Explain
how to use the "alias" feature to customize the plug. Share pictures of
configuration requirements.

Time Limit
2 weeks.
After finishing the document I would also be able to offer you a German Translation, which is my native language.

---
Task done. File is uploaded to the Google Servers. The German translation will follow during the next days.
Last edited by Benjamin Hättasch on Sat Dec 29, 2007 3:06 pm, edited 1 time in total.

User avatar
jlleblanc
Joomla! Guru
Joomla! Guru
Posts: 963
Joined: Fri Aug 19, 2005 12:37 am
Location: Washington, DC / NoVA
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by jlleblanc » Wed Dec 05, 2007 4:49 pm

Yes, a German translation would definitely be welcome! Let us know if you need any direction with the content.
Joseph L. LeBlanc: http://www.jlleblanc.com
Frontend components start here: /components/com_[name]/[name].php
Backend components start here: /administrator/components/com_[name]/admin.[name].php

User avatar
alledia
Joomla! Ace
Joomla! Ace
Posts: 1067
Joined: Tue Jul 18, 2006 3:55 pm
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by alledia » Tue Dec 11, 2007 5:06 pm

I'd be happy to help / review / mentor this project if needed.
Joomla extensions and templates: http://Joomlashack.com

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7018
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by AmyStephen » Wed Dec 12, 2007 7:10 am

Again, thanks Steve.

Benjamin -

Please let us know how you are doing. We would really like to hear from students every few days. That way, we can help answer questions or provide resources you need to be successful and we are able to keep track.

Steve is from Alledia, and he is *the* SEO expert in the Joomla! community. If he doesn't know the answer, there isn't one. ;) He can help you, so, do not hesitate to take advantage of his generous offer to help.

Thanks!
Amy :)

User avatar
alledia
Joomla! Ace
Joomla! Ace
Posts: 1067
Joined: Tue Jul 18, 2006 3:55 pm
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by alledia » Wed Dec 12, 2007 4:46 pm

Thanks Amy, for the intro and kind words

Hi theoclymenus

Please feel free to PM with any questions or post what you have here.
Joomla extensions and templates: http://Joomlashack.com

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7018
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by AmyStephen » Wed Dec 12, 2007 5:00 pm

Wherever possible, it's encouraged to keep the conversations in the open for transparency reasons, especially since it's a contest. But, also so that the community can learn and join in. Private discussions are not against the rules, but, we are encouraging full use of the forums.

Thanks!
Amy :)

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Wed Dec 12, 2007 9:04 pm

Sorry that I didn't answered for such a long time. I attached the first part of the document at this post. The second part will follow in one or two days. Now feel free to criticize me...  ;)
You do not have the required permissions to view the files attached to this post.

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7018
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by AmyStephen » Wed Dec 12, 2007 9:11 pm

Benjamin -

Very nice. I would like to suggest that you assume (at first) that people have mod_rewrite working.

So, for the next step, show them how to rename the .htaccess. Then, test for a google redirect, as per the task guidelines.

That way, most people can simply use the 2nd and 3rd SEF URL options and continue with something else

The only ones who need to get down and dirty with the Apache configuration issues are those with problems.

So, since this is such a difficult area for end users - assume a path of success to get most people through without intimidating them, then, for those who have problems, continue with them separately. (If that makes sense.)

SEF URLs are one of the biggest enhancements of Joomla!. This is an important task to educate people how to take advantage of this.

Good work so far - BEAUTIFUL work so far - nicely arranged.
Amy :)

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Wed Dec 12, 2007 9:46 pm

Ok, thanks for this very fast answer. I will do my very best to do the next part like you suggested it. I will show you the next part as fast as I can.

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7018
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by AmyStephen » Thu Dec 13, 2007 7:32 pm

Benjamin -

Let's make certain to cover this point that Kenmcd raised when helping a community member.

Thanks!
Amy

User avatar
alledia
Joomla! Ace
Joomla! Ace
Posts: 1067
Joined: Tue Jul 18, 2006 3:55 pm
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by alledia » Thu Dec 13, 2007 8:30 pm

Hi Benjamin

Its a good start and the screenshots look fine.

Some suggestions:

1) Section 1. You mention that search engines need "permanent, absolute URLs". Aren't the default Joomla URLs also unchanging. I think "permanent" is good, but also mention that search engine love URLs that are short and contain keywords that people are searching for.

The SEF URLs are also better for humans. Can you imagine telling someone on the phone that they need to go to:
mysite.com/index.php?option=com_content&view=article&id=1.....

Maybe list the advantages of SEF URLs in bullet points?

2) Is it worth explaining the URLs a little? For example:

index.php/the-news/1-latest-news/1-welcome-to-joomla

People might ask, "can I remove the index.php?" or "what does the number 1 mean?"
Joomla extensions and templates: http://Joomlashack.com

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Fri Dec 14, 2007 7:02 pm

AmyStephen wrote: Benjamin -

Let's make certain to cover this point that Kenmcd raised when helping a community member.

Thanks!
Amy
Thanks Amy, this was one of my biggest problems, I thought the problem would be my own XAMPP Configuration but I hope that the mod_rewrite will now work corectly. And also thanks alledia, I'm creating this bullet points at this moment and I could create an FAQ-Part at the end of the document, including your questions. So, if you can think of more of this questions, please post them here.

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7018
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by AmyStephen » Tue Dec 18, 2007 8:27 pm

Hows it going, Benjamin? Do you need any assistance?

A quick update would be appreciated.

Thanks!
Amy :)

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Tue Dec 18, 2007 8:42 pm

I nearly finished my work. I had to modfiy the configuration of my Apache Server and to do many more things, but now mod_rewrite works at my pc and I can finish the document. I will upload it during the next hour. I'm writing a part about trouble-shooting at activating this option in this moment.

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7018
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by AmyStephen » Tue Dec 18, 2007 8:53 pm

Just wanted to make certain you were not having mod_rewrite issues. Sounds like you are in good shape.

Thanks, much, for your prompt response,
Amy :)

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Tue Dec 18, 2007 10:04 pm

Here is the next version. I hope that I included most of the points you suggested. So after a little feedback I can improve the latest points in the document. I could also add the FAQ-part.
You do not have the required permissions to view the files attached to this post.
Last edited by Benjamin Hättasch on Tue Dec 18, 2007 10:07 pm, edited 1 time in total.

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7018
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by AmyStephen » Wed Dec 19, 2007 6:11 am

I would get rid of this entire section:
Using this Module is more difficult than activating SEF URLs or using URL Suffix, but it  offers you much more possibilities. By using complex rules you can create URLs like you want.

Step-By-Step-Introduction for an easy example using Mod_Rewrite
Before  you start to work  with Mod_Rewrite, make sure that you have basic knowledge about:
Using a FTP-Software
Simple logical Rules
What you need is:
a FTP-Software (e.g. FileZilla)
The right to create or edit files on the Server manually
Also make sure that you have got an Apache Webserver, still running Mod_Rewrite when using this module. Otherwise check paragraph “Activating Mod_Rewrite” in chapter “D” first.
“.htacces” --> .htaccess (several places)

+++

There are three SEF URL options - I think you are showing how to use two.

There are four different types of URLs.

1. Parameterized - http://example.com/index.php?option=com ... ew=article --- and so on...

2. Search Engine Friendly URLs - http://example.com/index.php/menu-name

3. Use Apache mod_rewrite (and rename htaccess.txt to .htaccess) - http://example.com/menu-name (index.php gone)

4. Add suffix to URLs - http://example.com/menu-name.html

Rules - must add sequentially (1, before 2; 2, before 3.)

++++

For the FAQ -

What are the numbers in your URLs?

Here's where I would like to see an example of what the URLs look like for each Joomla! component.

We'll wait to get to this section until the previous is clarified.

++++

Thank!
Amy :)

User avatar
trombonechamp
Joomla! Explorer
Joomla! Explorer
Posts: 403
Joined: Thu Nov 29, 2007 9:37 pm
Location: Minnesota, USA
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by trombonechamp » Wed Dec 19, 2007 1:25 pm

Here is an odt with tracked changes.  I hope this helps!

http://bernsteinforpresident.com/sef-1.odt
Leonard Bernstein for President -
Web Development Services: www.BernsteinForPresident.com
My Software Freedom Blog: Trombonechamp.Wordpress.com

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Wed Dec 19, 2007 4:23 pm

trombonechamp wrote: Here is an odt with tracked changes.  I hope this helps!

http://bernsteinforpresident.com/sef-1.odt
Thank you very much. It will help sure. Sorry that there are so many mistakes in the document, but english isn't my native language, as you have propably noticed.

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Wed Dec 19, 2007 5:03 pm

AmyStephen wrote: I would get rid of this entire section:

OK, I'm going to rebuild the text at this section and remove the long list of requirements - Done.

“.htacces” --> .htaccess (several places)
Already done.

+++

There are three SEF URL options - I think you are showing how to use two.

There are four different types of URLs.

1. Parameterized - http://example.com/index.php?option=com ... ew=article --- and so on...

2. Search Engine Friendly URLs - http://example.com/index.php/menu-name

3. Use Apache mod_rewrite (and rename htaccess.txt to .htaccess) - http://example.com/menu-name (index.php gone)
I'm going to add a little part about this option between the two options in the second part, including a short description of the advantages and a refer to the second chapter where the step-by-step-introduction is located. - Done

4. Add suffix to URLs - http://example.com/menu-name.html

Rules - must add sequentially (1, before 2; 2, before 3.)

Maybe I've done it wrong all the time, but in my tests the suffix worked also without using mod_rewrite. - I putted a part in, that recommends to activate the options in this order.
++++

For the FAQ -

What are the numbers in your URLs?

Here's where I would like to see an example of what the URLs look like for each Joomla! component.
I've done so, but my explainings may not be completly right.

We'll wait to get to this section until the previous is clarified.

++++

Thank!
Amy :)
I'm going to do the tasks and post the changed version later this - for me evening, for you - afternoon. - Done.

Thank you all for the great help,
Benjamin
Last edited by Benjamin Hättasch on Wed Dec 19, 2007 10:06 pm, edited 1 time in total.

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Wed Dec 19, 2007 10:07 pm

I hope I did all the things you suggested to me. I want to say thank you to you, thank you for the great help. Here is the file - final review please.
Benjamin

/e: I tried to correct the language misstakes.The attached file is the new one.
You do not have the required permissions to view the files attached to this post.
Last edited by Benjamin Hättasch on Thu Dec 20, 2007 9:55 am, edited 1 time in total.

User avatar
trombonechamp
Joomla! Explorer
Joomla! Explorer
Posts: 403
Joined: Thu Nov 29, 2007 9:37 pm
Location: Minnesota, USA
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by trombonechamp » Wed Dec 19, 2007 11:18 pm

Trouble-Shooting
-should be "Troubleshooting"
-The first Joomla! is still missing the "!"!!!

There are a couple spelling mistakes too, but you should be able to fix those with spell check.
english isn't my native language, as you have propably noticed.
If I were as good at Spanish as you are at English, I would be amazed!

Keep up the good work!
Leonard Bernstein for President -
Web Development Services: www.BernsteinForPresident.com
My Software Freedom Blog: Trombonechamp.Wordpress.com

jbelani1
Joomla! Apprentice
Joomla! Apprentice
Posts: 26
Joined: Thu Nov 29, 2007 7:19 pm

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by jbelani1 » Fri Dec 21, 2007 4:46 am

Hi Benjamin,

Great work so far, your document is written very well  :).  One mistake I saw however was "How does it have changed?" under Activating SEF URLs.  "How does it have changed?" should be "How has it changed?".  Other than that, great work!

-Josh

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Fri Dec 21, 2007 10:44 am

Ok, I corrected this mistake, thank you.

I've uploaded the two documents, so please final review. Thanks.

/e: I found a little language mistake, new version uploaded.
/e: Added German version
/e: Newest version is attached at the last post
/e: Deleted German Version

The new German Version will be uploaded during the next days.
Last edited by Benjamin Hättasch on Sat Dec 29, 2007 3:08 pm, edited 1 time in total.

User avatar
trombonechamp
Joomla! Explorer
Joomla! Explorer
Posts: 403
Joined: Thu Nov 29, 2007 9:37 pm
Location: Minnesota, USA
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by trombonechamp » Fri Dec 21, 2007 1:50 pm

Websites are search engine friendly, if the pages can easily be found by search engines.
Get rid of the coma.
These URLs are very long and contain a lot of parameters and the files that are shown to the visitors are not permanent files, as can be seen at the “?” in the URL.
This seems like a run-on.  I'd split it up into multiple sentences.
an d for you
Extra space between an and d
It is an Apache module to make your Website more search engine friendly.
Don't capitalize "website"
You have to contact your web hostering provider and request him/her to activate it.
Should be "hosting".
Then visit the Joomla!Forum.
"Joomla! Forum" is two words.



Also, some of the graphics overlap the text for me.  You might want to upload a PDF as well.

Nice work so far!
Leonard Bernstein for President -
Web Development Services: www.BernsteinForPresident.com
My Software Freedom Blog: Trombonechamp.Wordpress.com

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Fri Dec 21, 2007 6:15 pm

trombonechamp wrote: Also, some of the graphics overlap the text for me.  You might want to upload a PDF as well.

Nice work so far!
I've done everything. Here is the new file:
(The PDF file was to large, I'm going to upload it to my webspace and will put in the link afterwards.)
You do not have the required permissions to view the files attached to this post.

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7018
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by AmyStephen » Tue Dec 25, 2007 7:16 pm

Benjamin -

I rearranged your sections, a bit, so that those who have rewrite working and understand how to rename the htaccess file can get in and out quickly. Then, I added in some of the troubleshooting steps you linked to in order to keep it all in one document. I also added a few FAQ items to better address Steve's SEO points and a couple of issues that continue to come up in the forums.

Please take a look and see what you think. I'm happy to accept this, as complete, after you have reviewed.

Thanks! This is a HUGELY important document that will be used over and over.
Amy :)

Edit:
Added AllowOverride needed for Apache configuration.
You do not have the required permissions to view the files attached to this post.
Last edited by AmyStephen on Tue Dec 25, 2007 7:44 pm, edited 1 time in total.

Benjamin Hättasch
Joomla! Apprentice
Joomla! Apprentice
Posts: 24
Joined: Wed Dec 05, 2007 12:33 pm
Location: Bensheim - HESS - Germany
Contact:

Re: 110 - Create a document entitled "Joomla! v 1.5 SEF URLs"

Post by Benjamin Hättasch » Sat Dec 29, 2007 11:09 am

OK, Thank you Amy for correcting my language and the structure. I'm going to upload the file to Google now.

---

Here is the german file. And also the newest version of the english file, I found two little misstakes.
You do not have the required permissions to view the files attached to this post.
Last edited by Benjamin Hättasch on Sat Dec 29, 2007 9:29 pm, edited 1 time in total.

jonesbp
Joomla! Apprentice
Joomla! Apprentice
Posts: 14
Joined: Tue Feb 05, 2008 3:45 pm

Re: 110 - Create a document entitled

Post by jonesbp » Sat Feb 23, 2008 12:09 pm

Hi.
I think that this may be the topic that can help me.
I have sef urls enabled in Joomla 1.5.1. I have tried other commercial extensions but in the end have decided that the built in SEF in Joomla 1.5 is much better.
However, I wish to get rid of the numbers in my URLs.

e.g http://www.mysite.com/news/23-news/37-article.

what i want is:

http://www.mysite.com/news/article.

Is there a way to do this please?

User avatar
trombonechamp
Joomla! Explorer
Joomla! Explorer
Posts: 403
Joined: Thu Nov 29, 2007 9:37 pm
Location: Minnesota, USA
Contact:

Re: 110 - Create a document entitled

Post by trombonechamp » Sat Feb 23, 2008 12:37 pm

Hi.
I think that this may be the topic that can help me.
Sorry! This thread is from the GHOP contest (which has been over since the beginning of February). If you want help, I suggest you post in the Joomla! 1.5 general board. You can find this board at http://forum.joomla.org/viewforum.php?f=428. There are more people to help you on that board.

Thank you for your understanding!


Locked

Return to “Google's Highly Open Participation Contest”