Editing configuration: Difference between revisions

From MozillaZine Knowledge Base
Jump to navigationJump to search
(Add troubleshooting section)
(actoring out editor settings/troubleshooting into separate article in order to keep this article short and snappy. (It is the referral point for many articles instructing users to "set a preference".))
Line 7: Line 7:
To modify the way in which Web pages and e-mails are displayed, you should edit the [[userContent.css]] file. To modify the appearance of the application itself, you should edit the [[userChrome.css]] file.
To modify the way in which Web pages and e-mails are displayed, you should edit the [[userContent.css]] file. To modify the appearance of the application itself, you should edit the [[userChrome.css]] file.


==Editor settings==
==How to edit configuration files==
To edit configuration files, you might need to check your text editor's settings so that your editor saves files using the correct file type and character encoding.
The [https://addons.mozilla.org/extensions/moreinfo.php?id=17 ChromEdit] extension provides a convenient way of editing configuration files. ''At the time of writing (May 2006) ChromeEdit is not officially available for current versions of Mozilla applications, but an unofficial [http://home.iitk.ac.in/~anupamsr/chromedit.xml updated version] is available.''


===File type===
If you choose to edit your configuration files using your own text editor, you should consult the [[Editing configuration/Manual editing | Manual editing]] advice.
Ensure that your editor saves plain text files.


Some editors can ''only'' save plain text files.  These editors have no
==Troubleshooting==
setting for the type of file.
If you experience problems when editing configuration files, consult the [[Editing configuration/Troubleshooting | Troubleshooting]] article.
 
Some editors can save various types of file.  In this case, ensure that your
editor saves configuration files as plain text.
 
Some editors recognize file names ending in <tt>.css</tt> and <tt>.js</tt>
as CSS and JavaScript files respectively.  These editors automatically save
these files as plain text.
 
===Character encoding===
Configuration files use the UTF-8 character encoding (also known as character
set or charset), but you do not always need to use a text editor that supports
UTF-8.
 
For most purposes you only need to use basic English letters and symbols
([http://en.wikipedia.org/wiki/ASCII ASCII]) in your configuration files.
In these cases, you can use almost any
character encoding except Unicode.  If your text editor does not have any
setting for character encoding, then you can probably use it for ASCII
characters.
 
For some purposes you need to type accents or other characters that are not
ASCII.  If your text editor is set to use UTF-8, then simply type the
characters that you need.
 
If your editor does not support UTF-8, or if you cannot type the special
characters that you need, then encode each special character using its
hexadecimal Unicode representation.  In <tt>.css</tt> files, use a backslash
followed by hexadecimal digits.  In <tt>.js</tt> files, use <tt>\u</tt>
followed by exactly four hexadecimal digits.
 
For example, you can encode an information sign followed by a non-breaking
space like this:
 
''In <tt>userContent.css</tt>:''
:link:before {content: "\2139\a0";}
 
''In <tt>user.js</tt>:''
user_pref("mailnews.reply_header_ondate", "\u2139\u00a0 On %s");
 
===Checking your editor===
To check your text editor, create a plain text file named <tt>test.txt</tt>.
In the file, type some of the accents and special characters that you need.
Save the file somewhere on your computer.
 
Open the file in your web browser.  For example, in Firefox choose File &ndash;
Open File... and select the file, or drag the file's icon and drop it in
Firefox.
 
Set your browser's character encoding to UTF-8.  For example, in Firefox choose
View &ndash; Character Encoding &ndash; Unicode (UTF-8).  Check that your
browser displays the file correctly with this setting.
 
== Troubleshooting ==
If you make changes to a configuration file but the changes seem to have no effect,
here are some common causes that you can check:
 
<ul>
<li>You edited the wrong file, or created the file in the wrong place.</li>
<p>
Check that you found the [[profile folder | profile]] that is actually being
used by the application, not some other profile, and ''not'' the application's
[[installation directory]].</p>
<p>
Check that CSS files are in the <tt>chrome</tt>
directory in the profile, not in the profile directory itself.</p>
<li>The file contains errors.</li>
<p>
If you found the preference settings or CSS rules or on a web page,
copy and paste from the web page to avoid typing errors.</p>
<p>
If you have to edit the content, ensure that you preserve the correct punctuation.</p>
<p>
Check that the font in your text editor makes it easy for you to
see the difference between parentheses <tt>()</tt>, square brackets <tt>[]</tt>
and curly braces <tt>{}</tt>, and between colon <tt>:</tt> and semicolon
<tt>;</tt>.</p>
<p>
In the application, choose Tools &ndash; JavaScript Console...
(or Tools &ndash; Web Development &ndash; JavaScript Console...) to see
error messages.</p>
<p>'''Note:&nbsp;''' The JavaScript console does not always show errors relating to preference settings..
In recent versions of some Mozilla applications, it does show CSS errors.</p>
<li>CSS rules are being overridden by other rules.</li>
<p>
Try adding <tt>!important</tt> to any CSS rule that has no effect.  Add it
just before the semicolon at the end of the rule.</p>
<p>
If you are using a theme that you installed, try the CSS rules with the application's default theme.</p>
</ul>


==External links==
==External links==
<ul>
* The [https://addons.mozilla.org/extensions/moreinfo.php?id=2108 Stylish extension] provides an alternative way to change styles.  It does not use userContent.css or userChrome.css, and changes take effect without restarting the application.
<li>The [https://addons.mozilla.org/extensions/moreinfo.php?id=17 ChromEdit] extension provides a convenient way of editing configuration files.
<p>''At the time of writing (May 2006) ChromeEdit is not officially available for current versions of Mozilla aapplications, but an unofficial [http://home.iitk.ac.in/~anupamsr/chromedit.xml updated version] is available.''</p></li>
 
<li>The [https://addons.mozilla.org/extensions/moreinfo.php?id=2108 Stylish extension] provides another way to change styles.  It does not use userContent.css or userChrome.css, and changes take effect without restarting the application.</li>
</ul>
 
* [https://addons.mozilla.org Extensions and themes] provide many additional features and allow you to change the way your application looks.
* [https://addons.mozilla.org Extensions and themes] provide many additional features and allow you to change the way your application looks.
* [http://www.mozilla.org/support/firefox/edit Editing Configuration Files] at Firefox Help
* [http://www.mozilla.org/support/firefox/edit Editing Configuration Files] at Firefox Help

Revision as of 14:18, 11 June 2006

Mozilla applications are highly customizable, and there are a number of standard ways to change their appearance and behaviour. Basic settings can be changed using the application's dialog boxes. The main Options or Preferences dialogs can be reached from the "Tools" or "Edit" menus. (See menu differences in Windows, Linux, and Mac.)

Modifying preferences—adding, removing and setting

To make more advanced changes to the application’s behaviour—in particular, if you have been instructed to “set a preference”—you should either edit the user.js file, or use the about:config interface. Note that whilst it is often quicker to use about:config, editing the "user.js" file has the advantage of portability: your preferences will never be overridden, and they can be transferred to a different profile, or backed up for safe keeping.

Modifying appearance

To modify the way in which Web pages and e-mails are displayed, you should edit the userContent.css file. To modify the appearance of the application itself, you should edit the userChrome.css file.

How to edit configuration files

The ChromEdit extension provides a convenient way of editing configuration files. At the time of writing (May 2006) ChromeEdit is not officially available for current versions of Mozilla applications, but an unofficial updated version is available.

If you choose to edit your configuration files using your own text editor, you should consult the Manual editing advice.

Troubleshooting

If you experience problems when editing configuration files, consult the Troubleshooting article.

External links