Stud.IP Dokumentation

This page has not been translated yet. Help the project and contribute! Just click "Edit Page" and work on the translation draft.

Formatting text

Often there are questions like "How can I write my text in italyc type?" or "Why can´t I use bold type?". Here are the answers. It's not just working - it´s working very easily!

It´s not only possible to formate in bold type, italyc type or underlined type - you also may write smaller or larger, in inferior or superior type. Also listings or lines can be made, and professionals have the possibility to attach preformatted text, links and quotations. The following alternatives of formatting text work in

• the personal Stud.IP - Homepage
• the discussion forum
• publishing news
• personal messages
• chat
• Wiki

Simple formattings

Simple formattings are created easily. There you have to take account of two possible notations for all formattings :

• Formatting a single word really just works for only one word. Several formattings may not be nested, which means you may write a word in bold type or italyc type - but not contemporaneously.
• Formatting several words may retard over several paragraphs.

The following commands are available for simple text formattings:

If you want to modify the formatting of a word, you have to enter the formatting commands in front of the word and behind the word.

Example:

–––-> %Word%

–––-> turns to

–––-> Word

It´s also possible to connect several words with formatting characters. The space character is replaced by the formatting character in this case:

Example:

–––-> These are %italyc type%words%.

––––-> turns to:

–––-> These are italyc type words.

Please mind not using space characters between command characters and the word you want to format. That won´t work. Please mind also, that the word or the words you want to format have to be in one row.

If you want to format several words oder a complete sentence or paragraph, enter the formatting character twice directly in front of the first word and behind the last word.

Example:

%%A sentence in italyc type%%

turns to:

A sentence in italyc type

If you use the formatting characters twice, there are no problems with space characters or line-breaks. The text will be formatted until the second double formatting character is entered. Some formatting characters may be combined:

Example für special characters that may be combined:

This sentence is very %%in italyc type __and underlined__%%.

turns to:

This sentence is very in italyc type and undelined.

Of course you can do great things using formatting characters in different combinations.

For example:

+++++**e = mc>>2>>**+++++

turns to:

E = mc²

Type three times larger (++++++) in bold type (**) with superior 2 (>)

A very wild example for combining sentence formatting characters and word formatting characters:

%%The_house_stood on a hill outskirts of town. It was standing alone and overviewed **__the large farmland in the west__**. Absolutely no remarkable house - it was nearly ++++thirty years old, >plump>, <quadrangular<, made of bricks++++ and it had _four_windows_ on the front, which could not really **succeed** in gratifying the eye.%%

turns to:

The house stood on a hill outskirts of town. It was standing alone and overviewed the large farmland in the west}. Absolutely no remarkable house - it was nearly ['thirty years old, plump quadrangular made of bricks+] and it had {+four windows on the front, which could not really succeed' in gratifying the eye.''

Formatting paragraphs

You also may format paragraphs with indentations or numerations.

Indented paragraphs

To indent a paragraph push the return button two times and afterwards the space button. Key in your text and push return.

Example It looks like this:

This sentence isn´t indented.

   This sentence is indented.
   This sentence is indented. 
   This sentence is indented.
   This sentence is indented.
   This sentence is indented.   
   This sentence is indented.
   This sentence is indented.
   This sentence is indented.
   This sentence is indented. 

And this sentence isn´t indented again.

Numerations

You can assimilate numerations inside of a paragraph:

Every enumeration point starts at the beginning of a row with a - minus.Behind the minus enter a space character and the text. The enumeration point ends with a newsline (Return - Button ). The enumeration points end as soon as you don´t enter a minus at the beginning of the row.

Example:

I want to numerate the following informations:

- This is the first enumeration point. This is the first enumeration point.

- This is the second enumeration point.

- And this is the third and last enumeration point.

That´s it.

turns to::

I want to numerate the following informations:

• This is the first enumeration point. This is the first enumeration point.
• This is the second enumeration point.
• And this is the third and last enumeration point.

That´s it.

You can nest numerations.It´s the same procedure every time. Enter several minus characters depending on the level of numeration.

You can also enter numbers instead of enumeration points. You just have to enter equal signs instead of minus.

Formatting for professionals

To this category belong Preformatted text, Quoting, Text as link, Including pictures and Formatting program codes

Preformatted text:

Preformatted text means the text typed out with all space characters, line-breaks and tabulators as it was prepared (in word, for exmple). This way it´s possible to type out tables (no HTML - tables!) and serially numbered lists with several levels (or displaying a signature).

the syntax is

[pre] preformatted text [/pre]

The markups in front of [pre] and behind [/pre] the text can stand inside of a text or in an own row:

[pre] preformatted text [/pre]

Text acting as link: You can denounce a link not with the address of the link, but as a text. Syntax:

[Linkname]Address of the link

Only the text in the brackets is displayed. The bracket behind the linkname has to stand directly in front of the link. Don´t enter a space character here! All link addresses are allowed, also email addresses. Linknames can´t be formatted further up to now.

Example:

Hello, please write me an Email! Use this link: [Hello!]info@studip.de

turns to: Hello, please send an e-mail to me! Use this link: Hello!

Quotations:

If you want to answer a posting and quote the original text, you can use the Zitieren - Button underneath the original posting. If you only want to use some parts of the original posting, you should insert the command manually. Mark the text you want to quote and open a window to answer the posting. Insert at the beginning of the quote [quote], paste the copied text and insert [/quote] at the end of the quote. After sending the posting the text between the two commands appears as a quote.

Including pictures:

You can include pictures in Stud.IP, which are uploaded to the internet on other sites, for example on your own Homepage. Therefore you need the command [img]. After this command you put the address of the picture you want to link.

Example:

[img]http://www.studip.de/images/studip_logo.gif

turns to:

You can state further parameter of the picture. The syntax for this command:

[img=alt-text:Size:Orientation:URL]Picture-URL

The parameters mean:

• alt-Text: The text that appears if the image can´t be displayed
• Size: Amplitude in pixel or percent (related to the size of the window of your browser. If this can´t be established, max. 400px)
• Orientation: center für centered, right for right- justified orientation
• URL: Image as Link with URL

All parameters are optional. The denoted order must be followed if more than one parameter is given.

Formatting program code:

You can key program code (PHP - >code for example) in Stud.IP. To format it automatically, use the command [code]

Example:

turns to

Turning-off the formatting:

You have the possibillity to turn off all desribed formattings. That might be important if you have a text including many characters used in Stud.IP - formattings. To turn off the formattings insert [nop] in front of the text and [/nop] behind. Everything between [nop] and [/nop] won´t be formatted. This way you can format only one paragraph of a text or format the text without one paragraph.

Example:

##[pre][nop]This text is ++despitely ++ of its __many__ formattings commands
not formatted%%. But he´s preformatted
(you can see the large spaces between the words) and monospace typed.
[/nop][/pre]##

turns to:

This text is ++despitely++ of__its many__ formattings commands
nor formatted. But he´s preformatted
(you can see the large spaces between the words) and monospace typed. The syntax in the example ##[pre][nop]…text that shall be displayed… [/nop][/pre]## is lend itself to display programm source codes without surprises.