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)
 
(9 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
== How to modify a page ==
 
== How to modify a page ==
The site contains information in general about HTML but mostly, help for  
+
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 [[Access|Accessibility warnings]] ones,
+
* [[Access|Accessibility warnings]],
* and the [[Opensp|OpenSP]] errors and warnings.
+
* [[Opensp|OpenSP]] errors and warnings.
  
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 or add new page for topic that interest you about HTML.  For this, click on the '''EDIT''' tab on the top of each page.  
+
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.  
  
=== Structure ===
+
=== Wiki Page Structure ===
For each of these errors, the structure of the page is the same:
+
When editing a page, please follow these guidelines. For the following errors, the structure of the page is the same:
# Title: There is the title on the top
+
# Title: There should be an error title on the top of the page
# Cause: There is a cause that explain the reason of the error
+
# Cause: A cause that explains the reason for the error
# Example: Some samples but often a bad sample and a good one that show how to correct 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 what to do to fix this error
+
# Solution: A short description of the fix for this error
 
# References: URL References to W3C specifications or other interesting links about the topic.
 
# References: URL References to W3C specifications or other interesting links about the topic.
  
Here is an example structure:
+
Here is an example structure using the Wiki markup:
  
 
<good><pre>== Title ==
 
<good><pre>== Title ==
Line 31: Line 31:
 
* Describe the link: http://link.goes.here/</pre></good>
 
* Describe the link: http://link.goes.here/</pre></good>
  
=== Wiki ===
+
=== Wiki Markup ===
The pages are using a standard Wiki Syntax. For a quick help, look at:
+
The pages use a standard Wiki syntax. For a quick help, look at:
 
* Wikipedia Cheatsheet: http://meta.wikimedia.org/wiki/Cheatsheet
 
* Wikipedia Cheatsheet: http://meta.wikimedia.org/wiki/Cheatsheet
 
* Wikipedia Help: http://en.wikipedia.org/wiki/Help:Contents
 
* Wikipedia Help: http://en.wikipedia.org/wiki/Help:Contents
* MediaWiki help: http://meta.wikimedia.org/wiki/Help:Wikitext
+
* MediaWiki Full help: http://meta.wikimedia.org/wiki/Help:Wikitext
And 2 tags: &lt;good&gt;, &lt;bad&gt; for showing the good and bad samples.  
+
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 error if the page is not clear.
+
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 ===
 
=== Example ===
Finally, here is the example of one [[Sp_28|OpenSP error]] :
+
Finally, here is the example of an error [[Sp_28|OpenSP error]]. The error is reproduced below, for easy reference:
  
  
Line 48: Line 54:
 
== 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: