Format help

The format of the content published in this section is plain text, but standard HTML tags are also accepted and interpreted. Notice though that this does not mean the content is HTML - it is still plain text, since line breaks will still produce a line break (unlike in HTML), and invalid tags will be shown as plain text too.

For example:


<H3>C++ names</H3>
In C++, two names are <STRONG>the same</STRONG> if:
<UL>
<LI>they are <EM>identifiers</EM> composed of the same character sequence, or</LI>
<LI>they are <EM>operator-function-ids</EM> formed with the same operator, or</LI>
<LI>they are <EM>conversion-function-ids</EM> formed with the same type, or</LI>
<LI>they are <EM>template-ids</EM> that refer to the same class or function, or</LI>
<LI>they are the names of literal operators formed with the same literal suffix identifier.</LI>
<UL>

Will be formatted and shown as:

C++ names

In C++, two names are the same if:
  • they are identifiers composed of the same character sequence, or
  • they are operator-function-ids formed with the same operator, or
  • they are conversion-function-ids formed with the same type, or
  • they are template-ids that refer to the same class or function, or
  • they are the names of literal operators formed with the same literal suffix identifier.

Attachments and images

Attached files can be linked locally in the document. The same goes for images.
For example, if the files tutorial.pdf and tutorial.gif are attached to the document, the following code:


<IMG SRC="tutorial.gif">
<A HREF="tutorial.pdf">Click on this text to download the tutorial</A>

Shows the image and link:


Click on this text to download the tutorial

External links are allowed, but not the inclusion of external images (no hotlinking, please).

Embedding sourcecode

Documents can contain formatted C++ source code blocks by enclosing them between the special non-standard tags <SOURCECODE> and </SOURCECODE>. Any code between these tags is interpreted as C++ code: white-spaces are respected, and HTML interpretation is suspended inside the block. Special formatting is applied to the code highlighting some C++ features.

To show the results of a program, another pair of special non-standard tag exists: <OUTPUT> and </OUTPUT>.

For example:


This is the program that <EM>most</EM> programmers write for the first time:
<SOURCECODE>
// my first program in C++

#include <iostream>
using namespace std;
int main ()
{
  cout << "Hello world!" << endl;
  return 0;
}
</SOURCECODE>

See how we declare <VAR>main</VAR> as <SOURCECODE>int main ()</SOURCECODE> in line number 4.

When we compile and run this program, the screen will show:
<OUTPUT>
Hello world!
</OUTPUT>

This is formatted as:

This is the program that most programmers write for the first time:
1
2
3
4
5
6
7
8
9
// my first program in C++

#include 
using namespace std;

int main ()
{
  cout << "Hello world!" << endl;
  return 0;
}


See how we declare main as int main () in line number 4.

When we compile and run this program, the screen will show:
Hello world!


Format guidelines

Pages must be designed for a white background.

As a general rule, the title and the subtitle (if any) of a document are automatically inserted by the system as <H1> and <H2>. Therefore, it is recommended to use only <H3> (or deeper) for your main subsection titles.

A document will look sufficiently formatted by using just a few tags: <H3> and </H3> for the heading of your sections, <EM> and </EM> to highlight specific words, and <SOURCECODE>+</SOURCECODE> to enclose your code snippets.

That is enough for most needs. But you are free to format the document as you find convenient to properly structure the ideas you want to express.

We encourage you to focus your HTML code on structure and semantics and not so much on specifics about formatting. Thus, preferring tags such as <H3>, <STRONG>, <CODE> or <CITE>, over purely formatting tags like <I>, <TT>, <B>, when some kind of semantics for the text can be identified.

Valid HTML tags

Most valid Strict HTML4 tags are allowed, except those invalid inside the body element (BASE, BODY, HEAD, HTML, LINK, META and STYLE) or those introducing conditional content (NOSCRIPT and SCRIPT) and IFRAME.

Only non-deprecated tags are allowed and only non-deprecated attributes can be used in them (attributes to be dropped in HTML5 are also considered deprecated). Additionally, no attribute can use external URL values, and the ID attribute is not allowed.

Invalid tags or tags with invalid attributes will be shown in red when previewing the document. For more details on the specific error, hover the mouse over the invalid HTML tag.

Please edit the document and remove or correct any invalid HTML tags.

This is a list of all accepted tags and their corresponding attributes (All tags also accept the standard attributes CLASS, DIR, ID, LANG and TITLE):

Element tagDescriptionValid attributesNotes
AAnchorHREF, HREFLANG, RELAttribute TARGET deprecated
ABBRAbbreviated form
ADDRESSContact information of author
AREAClient-side image map areaALT, COORDS, HREF, SHAPEUse inside <MAP>
Attribute TARGET deprecated
BText style: Bold
BDOBidirectional OverrideDIRAttribute DIR required
BLOCKQUOTEQuote from another sourceCITEUse as general left-margin formatting tag is deprecated.
BRLine breakAutomatically generated. Use only for extra line breaks.
BUTTONForm buttonDISABLED, NAME, TYPE, VALUE
CAPTIONTable caption
CITECitation
CODECode
COLTable columnSPANUse inside <TABLE>
COLGROUPTable column groupSPANUse inside <TABLE>
DDDefinition descriptionUse inside <DL>
DELDeleted partCITE, DATETIME
DFNDefinition
DIVDivision
DLDefinition list
DTDefinition titleUse inside <DL>
EMEmphasize
FIELDSETForm fieldset
FORMFormACTION, ACCEPT, ACCEPT-CHARSET, ENCTYPE, METHOD
H1, H2, H3, H4, H5, H6Section header
HRHorizontal line
IText style: Italics
IMGImageALT, HEIGHT, SRC, USEMAP, WIDTHAttributes ALT and SRC required
INPUTForm Input fieldACCEPT, ALT, CHECKED, DISABLED, MAXLENGTH, NAME, READONLY, SIZE, SRC, TYPE, VALUE
INSInserted partCITE, DATETIME
KBDKeyboard text
LABELLabel for form elementFOR
LEGENDLegend for form fieldset
LIList itemUse inside <OL> or <UL>
MAPImage mapNAME
OBJECTEmbed objectDATA, HEIGHT, NAME, TYPE, USEMAP, WIDTH
OLOrdered listUse <LI> for the list items
OPTGROUPGroup form optionsDISABLED, LABELAttribute LABEL required
OPTIONForm optionsDISABLED, LABEL, SELECTED, VALUEUse inside <SELECT>
PParagraph
PARAMObject parameterNAME, TYPE, VALUEAttributes NAME and TYPE required
Use inside <OBJECT>
PREPreformatted text
QShort quotationCITE
SAMPSample computer output
SELECTForm select fieldDISABLED, MULTIPLE, NAME, SIZEUse <OPTION> for the options
SMALLSmaller text
SPANText span
STRONGStrong text
SUBSubscript text
SUPSuperscript text
TABLETableSUMMARY
TBODYTable bodyUse inside <TABLE>
TDTable cellCOLSPAN, HEADERS, ROWSPANUse inside <TR>
TEXTAREAMultiline text form inputCOLS, DISABLED, NAME, READONLY, ROWS
TFOOTTable footerUse inside <TABLE>
THTable header cellCOLSPAN, ROWSPAN, SCOPEUse inside <TR>
THEADTable headerUse inside <TABLE>
TRTable rowUse inside <TABLE>
ULUnordered listUse <LI> for the list items
VARVariable

IMPORTANT: Documents do not go live into their respective section in the website until approved by a site editor.