JoomDOC

From Kb_JMY(晉明夷)

Jump to: navigation, search

Contents

JoomDOC aims to consolidate all documentation of Joomla CMS and Extensions in this single place.

If you are interested to join, you are welcomed to register, create or edit un-protected pages. The Policy of Protected Pages is to avoid Vandalism and Spaming.

If you are a good guy and a experienced Joomlais, pls. register and send your email introduction to the adminstrator through internal email of this site. The adminstrator will handle your case asap.

You are welcomed to register, create your own, and suggest, but current Joomla Documentations includes:

Template Design


Joomla General

Joomla! Stats of the Month: 2006_10

FAQ(Joomla System)

How to change joomla icon on the URL?

  • Ref:
  1. How to change joomla icon on the URL? 2006.12.05
  2. FAQ: How do I change the favicon? 2006.08.31
  3. docs.joomla.org -- How do you change the favicon for Joomla v1.5.x?


  • Solutions(Joomla v1.5.x):
  • Assume: Joomla installation directory is public_html/mfy
  • For Frontend: simply put the file favicon.ico (size: 16x16) into public_html/mfy
  • For backend: put it into public_html/mfy/administrator
  • If you want different favicons for different templates, then put it into each template directory:
  • e.g. Frontend: public_html/mfy/templates/template01,
  • e.g. Backend:public_html/mfy/administrator/templates/adminTemplate01


  • Solutions(Joomla v1.0.x):
  • The joomla favicon is in the <Joomla_Directory>/images folder. The file is called favicon.ico and by definition a favicon must be 16x16.
=> Replace this file with your own one => That's it!
(Note: Clear your browser cache if you want to see your own favicon immediately)
  • Alternatively, you can change the favicon in the Joomla! global configuration Site tab (on the bottom).

Joomla v1.0.12: How to disable the security warning?

  • Questions: How do I disable the warning:
" Warning: Installing 3rd party extensions may compromise your server's security. Upgrading your Joomla! installation will not update your 3rd party extensions. For more information on keeping your site secure, please see the Joomla! Security Forum."
  • Solutions: Υou can replace it with a happy message through your language file!

Installation

How to set Joomla's default image directory outside Joomla's root?


Site Administration


Joomla Official Documentation

Download Joomla v1.0.11 User Manual

User Manual Forum

Join the Joomla Doc.Team


  • Joomla's Developer Network
http://dev.joomla.org
Developers Blog Joomla! Core Developers each have a blog to keep you up to date with current work, thoughts and ideas.
Working Groups Want to help? Look into our many working groups.
Documentation Wiki The working groups use the wiki to draft tutorials, specifications, api references and other development related information. The wiki is updated almost weekly.

Joomla v1.0.11 stable

Joomla v1.5beta

Joomla Template

Most Designers use various PHP code to show/hide columns depending if there is any content published in that location (discussed in tips and tricks).
  • Current Problems:"rhuk_milkyway"
Chinese display problem in IE
What is the short-cut key to by-pass the cache and refresh the webpage?


Changing the footer


Module Display Control

(2) joomla.org -- How to keep the virtuemart menu displayed when a menu item of the virtuemart menu is clicked?


.htaccess

Redirect All Visitors to a subdirectory

  • Ref:
  1. WebWeaver.nu: Redirect Visitors To a New Page /Site
  2. JavascriptKit.com: Comprehensive guide to .htaccess redirection
  3. StevenHargrove.com: Webpages Redirection
  4. Apache 1.3: Official Mode Rewrite Document
  5. Apache 1.3: URL Rewriting Guide
  • Introduction: If you've moved a few pages or even a whole site, here are a few ways to get your visitors to where they were going by automatically redirecting them.


"301 Redirect" Using PHP

  • This method is recommanded as it has tested to be compatible with cpanel 's subdomain redirection function.
(such as http://kb.yoursite.com/ --> http://yoursite.com/kb/) 
<?
header( "HTTP/1.1 301 Moved Permanently" );
header( "Status: 301 Moved Permanently" );
header( "Location: http://www.new-url.com/jmla" );
exit(0); // This is Optional but suggested, to avoid any accidental output
?>

"301 Redirect" Using Mod_Rewrite

  • Mod_Rewrite has got to be one of the most usefull modules a server can have, it allows to organize the file structure of your web site in a dynamic yet simple fashion, in this example I show a useful method of 301 redirecting with mod_rewrite. 
RewriteEngine On
rewritecond %{http_host} ^yoursite.com
rewriteRule ^(.*) http://www.yoursite.com/$1 [R=301,L]


301 Redirect Using .htaccess

  • Problems: The subdomain function of cpanel becomes disabled!


  • Redirect Entire Site to a subdirectory
Redirect /index.html http://yoursite.com/jmla/
  1. there are 3 parts: the Redirect command, the location of the file/directory you want redirected relative to the root of your site (/index.html = yoursite.com/index.html) and the full URL of the location you want that request sent to.
  2. Each of the 3 parts is separated by a single space, but all on one line.
  3. CANNOT replace "/index.html" with just the public_html root directory "/", otherwise an infinite loop will be formed and the redirected address becomes http://www.example.com/jmla/jmla/jmla/jmla/.... => hanged until apache timeout!


  • Redirect a webpage to another webpage of another site
Redirect /oldpage.html http://www.example.com/newpage.html

Using Meta redirection -- DON'T USE!

  • Over the past 4-6 years, use of meta tag refresh redirection has been abused for uses in relation to SPAM. The result of this and other scenarios of mis-uses of it, is that when using it, that page WILL be de-indexed from every search engine.
NOTE: This also applies to javascript redirection. Search engines can easily detect javascript and meta tag redirection, so just dont do it, use the 301 redirect.


  • Example index.html
  1. it is placed in public_html
  2. it redirects all traffic of http://abc.com to http://abc.com/joom/
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="refresh" content="0; url=http://abc.com/joom/index.php">
<meta http-equiv="REFRESH" content="0; url=joom/index.php">
<title>redirect</title>
</head>
<body>

</body>
</html>

Mode Rewrite

  • Ref:
  1. Apache 1.3: Official Mode Rewrite Manual -> RewriteBase
  2. Apache 1.3: URL Rewriting Guide


  • Example1:
RewriteEngine On
rewriteRule ^file_number_(.*).html http://www.yoursite.com/newFolder/new_file_numer$1.html [R=301,L]
In this case, the (.*) registered the wildcard, and the “$1″ executes the value of it
  • Example2: 
RewriteEngine On
rewritecond %{http_host} ^yoursite.com
rewriteRule ^category(.*).html(.*) http://www.yoursite.com/ [R=301,L]

This would redirect any page with the category[X].html?[x], e.g:
http://yoursite.com/category24.html?PHPSESSID=2347ab
http://yoursite.com/category128.html?PHPSESSID=24c7a

to your home page, http://www.yoursite.com/

SEO (Search Engines Optimization)

FAQ(SEO)


JoomSEF

Installation

  • Install the JoomSEF as usual Joomla components
  • Enable SEF in Joomla's global configuration


  • Install JoomSEF 1.2.5 support for Virtuemart "
  1. This hack "JoomSEF_v1.2.5_vm_hack.zip" is brought to you by Joomlicious: http://joomlicious.com
  2. "sef.php" is base file for JoomSEF 1.2.5 and based on "com_virtuemart_v1.2.4.php"
  3. To install, unzip archive at the root of your joomla installation and the files will be put in the right directory.

htaccess file

  • After installation,
  1. the ".htaccess" file is created if not exist;
  2. it should be located in the Root Directory of Joomla;
  3. "RewriteBase /jmla": set RewriteBase to jmla if Joomla is installed in the subdirectory "public_html/jmla";
  4. the ".htaccess" file should look like this:
DirectoryIndex index.php
RewriteEngine On
RewriteBase /jmla
RewriteCond %{REQUEST_URI} ^(/component/option,com) [NC,OR]
RewriteCond %{REQUEST_URI} (/|\.htm|\.php|\.html|/[^.]*)$ [NC]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule (.*) index.php

Support for 3rd party components

  • The situation is slightly different for 3rd party components. There exists many 3rd party components and modules for Joomla!, which usually differ significantly in complexity and structure. This means that for some of those (usually the simple ones), the SEO will work using the the default JoomSEF component handler. The others (usually more complex ones) may cause problems when used with the default handler. Such problems may include errors, loss of functionality, insufficient SEO, or generation of duplicate URLs. These can be either skipped in JoomSEF Control Panel, so no SEF URLs will be generated for them, or will require a special "extensions".


List of Official Extensions Available @2006.12.04
  • AlphaContent (free)
  • DocMan (free)
  • JoomlaBoard (free)
  • Mosets Tree (free)
  • Zoom Galery (free)
  • Jomres (on request)
  • SMF Bridge (Simple Machines Forum) (need to pay)
  • VirtueMart (need to pay)


  • Extension Installation
To install extra SEF extension for a component, use installer accessible from the JoomSEF Control Panel.
  1. Click "Install" tool in the toolbar
  2. Use "Upload file" box to select an extension installation file and press "Upload and Install" button
  3. If everything went ok, you should get an confirmation screen with installation status; after clicking "Continue..." link, your new SEF extenstion is ready to use

After Installation

  • Installed: Joomla v1.0.11 (utf-8) + JoomFish 1.7 + JoomSEF1.3.0 + VirtueMart 1.0.7
  • Site Languages: English (Eng), Traditional Chinese (tChi) & Simplified Chinese (sChi)
  • Default site language: tChi
  • After installation, the converted SEF links can be found by:
-> components -> Artio JoomSEF -> View/Edit SEF URLs
  • Examples SEF links and original links:
  • Search (in mainmenu):
2.html --> index.php?Itemid=5&option=com_search
en/search.html --> index.php?Itemid=5〈=en&option=com_search
tw/search.html --> index.php?Itemid=5〈=tw&option=com_search
cn/search.html --> index.php?Itemid=5〈=cn&option=com_search


404: Not Found Error


  • Due to some reasons, JoomSEF converts some of the links incorrectly and 404: Not found Errors happens. For examples:
  • Contact Us (in mainmenu)
  • When JoomFish Language selector is selected to English(en), Traditional Chinese (tw) & Simplified Chinese (cn) respectively, "404:Not Found" Error happens:


404: Not Found
Sorry, but the content you requested could not be found
FILE NOT FOUND: en//index.php
URI:/jmla/en//index.php


404: Not Found
Sorry, but the content you requested could not be found
FILE NOT FOUND: tw//index.php
URI:/jmla/tw//index.php


404: Not Found Error
Sorry, but the content you requested could not be found
FILE NOT FOUND: cn//index.php
URI:/jmla/cn//index.php
  • Check from JoomSEF backend:
The SEF urls and original urls of "Contact Us" are found as follows:
/index.php --> index.php?Itemid=3&option=com_contact
/view.html --> index.php?Itemid=3&contact_id=1&option=com_contact&task=view
en//index.php --> index.php?Itemid=3〈=en&option=com_contact
tw//index.php --> index.php?Itemid=3〈=tw&option=com_contact
cn//index.php --> index.php?Itemid=3〈=cn&option=com_contact


  • Solution (select, delete & re-generate)
  • Simply rectify the incorrect SEF URLs by copying "contact-us" in between lanuguage headers (i.e. "en", "tw", & "cn" here) and "/index.php" as shown belows:
/index.php --> index.php?Itemid=3&option=com_contact
contact-us/view.html --> :index.php?Itemid=3&contact_id=1&option=com_contact&task=view
cn/contact-us/index.php --> index.php?Itemid=3〈=cn&option=com_contact
en/contact-us/index.php --> index.php?Itemid=3〈=en&option=com_contact
tw/contact-us/index.php --> index.php?Itemid=3〈=tw&option=com_contact
The following method is not reliable!
--------------------------------------
  1. In the frontend, click "home" -> "Contact Us" (no need to care about the which language the JoomFish language selector is selected).
  2. In the backend, click "component" -> "Artio JoomSEF" -> "View/Edit SEF Urls" -> component: Contact Us
  3. delete all SEF Urls -> then a new sets of SEF Urls will be generated
  4. check if they looks corrects! If not, delete them all and check again, till they looks correct
  5. the correct SEF Urls of "Contact Us" should look like this:
/index.php --> index.php?Itemid=3&option=com_contact
contact-us/view.html --> :index.php?Itemid=3&contact_id=1&option=com_contact&task=view
cn/contact-us/index.php --> index.php?Itemid=3〈=cn&option=com_contact
en/contact-us/index.php --> index.php?Itemid=3〈=en&option=com_contact
tw/contact-us/index.php --> index.php?Itemid=3〈=tw&option=com_contact

Multi-Lingual Sites

Getting help

Joom!Fish

Installation

  • Install the component "com_Joom!Fish_Content_Element_Installer_v1.1_com.jfcei.zip" (JCEI)
-- After installation, change the permissions of the directory "<Joomla root>/administrator/components/com_jfcei/" and all files under it from "777" or "666" to "755", otherwise you may get "Internal Server Error 500" when the "install content element" icon of Jcei is clicked
-- This component allow you to upload JoomFish supporting plugin for other Joomla addons, such as VirtueMart.
-- Note that
  1. These supporting plugin CANNOT be installed using Joomla's original mambots installer
  2. Use JCEI to upload the files of "JoomFish supporting plugin" one by one and NOT AS ZIP.
  3. You may upload these plugin files directly into the directory "<Joomla Root>/administrator/components/com_joomfish/contentelements/", without the use of JCEI. (pls. see Multilanguage Guide for VirtueMart)


  • Setting ISO codes: After installation, Goto "Joom!Fish 語言管理" and make sure that you have entered all the Official ISO codes of the corresponding languages, otherwise the JoomFish language selector in the frontend cannot go to the languages that without the ISO codes being inputed:
For examples:
en -> for English
tw -> for Traditional Chinese
cn -> for Simplified Chinese
Pls. see also Installed 3 languages, but always goes to Traditional Chinese, Pls. help!


  • Translating Date &Time
Ref:
  1. forge.joomla.org: Translating Date &Time
  2. How to display Date and Day in local language.
If you want your Joomla! site to show a translated time and/or date when you switch languages, all you need to do is add a setLocale( <SERVER_ISO> ) into your language files.
For example, in a German language file you would add the code "setLocale( 'de' );"


  • 2006_1127(Mon) -> still CANNOT get good solution!!!
finally set locale back to "en_US" in the golal configuration of Joomla administrator backend, as temporary.
setting locale to "zh_TW" will have correct Traditional Chinese (tChi) display in the date display, when tChi is selected in the language selector, but still display month and day in tChi (but in Big5 code, and hence corrupted screen) even when English is selected in the language selector.


  • Complete Country Locale Settings for translating date &time
Ref: No translation on date format
look in Site-Global Configuration-Locale-Contryn Locale
e.g
zh_TW (Chinese_Taiwan)
zh_HK (Chinese_Hong Kong)
zh_CN (Chinese_China)
en_GB (English_United Kingdom)
en_US (English_United States)
nl_NL
da_DK
where,
language - lowercase two-letter ISO 639-1 codes (see also ISO-639 codes for all ISO-639 codes)
country - uppercase two-letter ISO3166-1 Alpha-2 codes, (see also ISO-3166 code for all ISO3166 codes)

Making Your Second Language Site

  • Select and set the Default Site Language, e.g. English


  • Translate into your second language site, e.g. Traditional Chinese
  1. First: the frontend menu items, e.g "Contact Us" of mainmenu &topmenu, "My Profile" of usermenu;
  2. Second: the module names, e.g. "Main Menu" & "User Menu", "Login Form", "Who's Online?"
  3. last: the content pages


  • The translation details: using "Contact Us" of "mainmenu" as an example
  1. In the adminstrator backend, click "components" -> JoomFish -> Translation
  2. then select "Content Elements" to "menus"
  3. -> "Menu filter" to "mainmenu"
  4. -> "languages" to "Traditional Chinese"
  5. click on "Contact Us", as listed, to add the corresponding Traditonal Chinese traslation
  6. "Publish" the translation and click "save".
  7. That's it!

JoomFish &SEO


(JoomSEF+JoomFish) or (OpenSEF+JoomFish)?

Multi-language and SEF (with custom static URLS that you define yourself)
Currently, there is no 'official' way of achieving both at present, the three options are
1. Use JoomSEF and JoomFISH
good = compatible
bad = no custom URLS
(NB: Next version of JoomSEF might have custom links...)


2. Use OpenSEF and JoomFISH
good = custom URLS
bad = not compatible :-(
(NB: Next version of OpenSEF ( rc6) might be JoomFISH compatible)


3. Use OpenSEF and JoomFISH with the JoomFish OpenSEF patch
good = custom URLs, compatible
bad = not 'official' release (as far as I can tell)


Conclusion: Having tried both OpenSEF and JoomSEF it seems to me that OpenSEF is more flexible/powerful/customisable it just doesn't currently have JoomSEF support. I will try the patch (see point 3) above and report back.
« Last Edit: November 09, 2006, 04:33:34 AM by dweezil99 »

Jobline & Joomfish


SimpleFAQ & JoomFish

FAQ(Multi-Lingual)

How to save a visitor's language selection and retrieve it next time when...?

  • Ref: [How to save a visitor's last language selection and retrieve it next time when he visits my site again?]
  • Answer: This is already implemented in Joom!Fish systembot

Installed 3 languages, but always goes to Traditional Chinese, Pls. help!

IE cannot detect my site's language (UTF-8), how to correct?

  • Solution#1: thru ".htaccess"
Add the following code to "public_html/.htaccess", though Joomla is installed in a sub-folder of public_html
"AddDefaultCharset UTF-8"


  • Solution#2: thru "language.php"
Hi, I had the same problem, that cause that in the language.php file, the _ISO setting was not correct:
DEFINE('_ISO','charset=utf8');
Note that a hyphen ("-") is missed in "utf8", so correct it to:
DEFINE('_ISO','charset=utf-8');

Error: Deprecated use of JoomFish, pls. help!

  • Ref:
  1. Error: Deprecated use of JoomFish, pls. help!
  2. When JoomFish meets Extended Menu -> Depreciated Error, Any ideas to correct?[1]
  • Reason Found: Conflict with Extended Menu Module!
=> temporary solution: disable the mainmenu as produced by Extended Menu and use the original mainmenu.

Three JOOMLAs in ONE ?

Joom!Fish, but problem when cache enabled

Retrieved from "http://kb.healthkb.org/view/JoomDOC"



Personal tools