Difference between revisions of "How to modify a page"

From Htmlpedia
Jump to: navigation, search
 
m (Reverted edits by AcelmOnpas (Talk); changed back to last version by Mgueury)
 
(31 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== How to  
+
== How to modify a page ==
The site contains some general information page but mostly,
+
This site contains general information about HTML, but mostly it contains help for the following:
* the [[HTML_Tidy|HTML_Tidy]] errors and warnings.
+
* [[HTML_Tidy|HTML_Tidy]] errors and warnings,
* the [[Opensp|OpenSP]] errors and warnings
+
* [[Access|Accessibility warnings]],
* the [[Access|Accessibility warnings]] ones.
+
* [[Opensp|OpenSP]] errors and warnings.
  
For each of these errors, the structure of the page is the same:
+
Currently a lot of '''OpenSP''' and '''Accessibility''' pages have missing samples or unclear descriptions. You are welcome to contribute and improve these pages, or you may add a new page for topics that interest you about HTML.  To do this, click on the '''EDIT''' tab on the top of each page.  
# Title: There is the title on the top
 
# Cause: There is a cause that explain the reason of the error
 
# Example: Some samples but often a bad sample and a good one that show how to correct the error
 
# Solution: A short description of what to do to fix this error
 
# References: Reference to W3C specifications or other interesting links about the topic.  
 
  
Currently a lot of pages of OpenSP and Accessibility have missing samples or unclear description. You are welcome to contribute to improve the help of the errors.
+
=== Wiki Page Structure ===
 +
When editing a page, please follow these guidelines. For the following errors, the structure of the page is the same:
 +
# Title: There should be an error title on the top of the page
 +
# Cause: A cause that explains the reason for the error
 +
# Example: Some error samples. Often a bad sample and a good one that show how to correct the error will suffice
 +
# Solution: A short description of the fix for this error
 +
# References: URL References to W3C specifications or other interesting links about the topic.
  
And/or ask questions in the "Discussion" Tab of error.
+
Here is an example structure using the Wiki markup:
Here is the example of the OpenSP error [Sp_28]
+
 
 +
<good><pre>== Title ==
 +
=== Cause: ===
 +
Describe the cause of the problem here.
 +
 
 +
=== Example: ===
 +
&lt;bad&gt;A sample showing incorrect syntax&lt;/bad&gt;
 +
&lt;good&gt;A sample showing corrected syntax&lt;/good&gt;
 +
 
 +
=== Solution: ===
 +
Describe the solution (or solutions) here.
 +
 
 +
=== References: ===
 +
* Describe the link: http://link.goes.here/</pre></good>
 +
 
 +
=== Wiki Markup ===
 +
The pages use a standard Wiki syntax. For a quick help, look at:
 +
* Wikipedia Cheatsheet: http://meta.wikimedia.org/wiki/Cheatsheet
 +
* Wikipedia Help: http://en.wikipedia.org/wiki/Help:Contents
 +
* MediaWiki Full help: http://meta.wikimedia.org/wiki/Help:Wikitext
 +
In addition to the above syntax links, and 2 tags: &lt;good&gt;, &lt;bad&gt; for showing the good and bad samples.
 +
 
 +
You can of course ask questions in the '''DISCUSSION''' Tab of the error if the page is not clear.
 +
 
 +
=== Test ===
 +
 
 +
To test on a empty MediaWiki, please use:
 +
* http://test.wikipedia.org/
 +
* [[sandbox]] 
 +
 
 +
=== Example ===
 +
Finally, here is the example of an error [[Sp_28|OpenSP error]]. The error is reproduced below, for easy reference:
 +
 
 +
 
 +
----
  
 
== OpenSP: unterminated comment: found end of entity inside comment ==
 
== OpenSP: unterminated comment: found end of entity inside comment ==
 
=== Cause: ===
 
=== Cause: ===
Check that you are using a proper syntax for you comments, e.g: &lt;!-- comment here --&gt;.  
+
Check that you are using a proper syntax for your comments, e.g: &lt;!-- comment here --&gt;.  
 
This error may appear if you forget the last "--" to close one comment, therefore including the rest  
 
This error may appear if you forget the last "--" to close one comment, therefore including the rest  
 
of the content in your comment.
 
of the content in your comment.

Latest revision as of 22:13, 25 May 2009

How to modify a page

This site contains general information about HTML, but mostly it contains help for the following:

Currently a lot of OpenSP and Accessibility pages have missing samples or unclear descriptions. You are welcome to contribute and improve these pages, or you may add a new page for topics that interest you about HTML. To do this, click on the EDIT tab on the top of each page.

Wiki Page Structure

When editing a page, please follow these guidelines. For the following errors, the structure of the page is the same:

  1. Title: There should be an error title on the top of the page
  2. Cause: A cause that explains the reason for the error
  3. Example: Some error samples. Often a bad sample and a good one that show how to correct the error will suffice
  4. Solution: A short description of the fix for this error
  5. References: URL References to W3C specifications or other interesting links about the topic.

Here is an example structure using the Wiki markup:

Good
== Title ==
=== Cause: ===
Describe the cause of the problem here.

=== Example: ===
<bad>A sample showing incorrect syntax</bad>
<good>A sample showing corrected syntax</good>

=== Solution: ===
Describe the solution (or solutions) here.

=== References: ===
* Describe the link: http://link.goes.here/

Wiki Markup

The pages use a standard Wiki syntax. For a quick help, look at:

In addition to the above syntax links, and 2 tags: <good>, <bad> for showing the good and bad samples.

You can of course ask questions in the DISCUSSION Tab of the error if the page is not clear.

Test

To test on a empty MediaWiki, please use:

Example

Finally, here is the example of an error OpenSP error. The error is reproduced below, for easy reference:



OpenSP: unterminated comment: found end of entity inside comment

Cause:

Check that you are using a proper syntax for your comments, e.g: <!-- comment here -->. This error may appear if you forget the last "--" to close one comment, therefore including the rest of the content in your comment.

Example:

Bad<!-- comment here >
Good<!-- comment here -->

Solution:

Fix the broken comment.

References: