Help:Contents

From OptiYummy

Contents 1 Cooperation at OptiYummy 2 Editor Features 3 Table 4 Mathematical Formula (LaTeX) 5 Upload Pictures 6 Insert Picture in Text 7 Additional Information for Image

[edit] Cooperation at OptiYummy

Until further notice, editing of the contributions is possible only for registered users. Therewith, a qualitative high standard of available informations should be assured. The authors guarantee with their names the professional and proprietary correctness of their contributions. Interested parties can apply for the cooperation at the operator of this Wiki-System (see OptiYummy:General_disclaimer).

[edit] Editor Features

OptiYummy is operated based on MediaWiki. The help system of Wikipedia describes detailed how to create and to edit a new page at such Wiki-System. Therewith, an inexperienced author can edit and format the text quickly:

Entry to Text Layout (Wikipedia)

Attention: no umlaut and special characters for name of pages!

Umlaut "ß" and special characters shouldn´t be used for the name of new pages. It is a danger that problems with different character sets arise from the required port of the data base to a new Wiki-system. Dependent on the character set, the special characters will be interpreted different that the whole structure of links of the Wiki-system will be destructed!

[edit] Table

A detailed help for table at the Wikipedia Table.

Attention:

Unfortunately, the class="wikitable" is not able to use.

Hint:

For a simple table, a style of the typewriters without formatting should be used. Put a space character before each table row. Columns and layout will be adapted visual at the edit mode. The results according to the view of edit mode. See folowing example:

Name      | Comment          | Value    | Unit
-------------------------------------------------
my0       | Magn. Field      | 1.256E-6 | H/m
Bmax_zul  | Max. Flux        | 1.2      | T
d_Anchor  | AnchorDiameter   | 10       | mm
L_Factor  | L_Anch/d_Anchor  | 2        | -
rho_Iron  | Mass Density     | 7.8      | g/cm³

[edit] Mathematical Formula (LaTeX)

The MediaWiki editor contains a button for inserting of formulas. However, the formula must be written as Tex source code. It needs getting used to for amateur.

The help system of Wikipedia gives a good survay of formula notation:

Displaying a Formula (Wikipedia)

The result can be controled by preview to check for errors.

It is considerable more simple to create and modify the formula separate, e.g. install the program LyX on the PC:

• Download and install the software from http://www.lyx.org
• After start, activate the source view
• Create the formula with the grafic tools in the grafic mode
• The source code of the related formula appearances in the source code editor
• If the formula is done, copy the source code to the Wikipedia editor

[edit] Upload Pictures

The pictures can be copied from the own computer to the data base of OptiYummy using upload via "Specialpage Upload" (Log-in required before)

There, all pictures are save in a same directory. The picture should be named therefore different. As prefix, the page name should be used. Herewith, a simple assignment to the right text page is possible.

The name of the picture should describe the content of the picture. It dos´nt matter if the name will be very long.

Example: The jpg-image of the MeassurePlace on the page "ParameterIdentification" should be named:

ParameterIdentification-MeasurePlace.jpg

Which pictures available on the data base can be displayed via "Specialpage File List".

Size of the image files:

• the storage space for archieve of pictures is not limited
• But, a fast access via internet allows only max. 1-2 MByte for one image
• The quality of the picture must be good.

Prview- and original image:

• The so-called "Thumbnails" with a small-format can be created from a large-format file during loading the page of the Wiki-system.
• The key word "thumb" must be used in the image link. these picturtes are generated standardly with max. dimension of 200 pixel
• The size of the picture can be changed via syntax at the image link
• All pictures habe to be available in 3 formats:
  • Preview pictures in text (200 pixel)
  • Quality according the screen (800 pixel)
  • Original pictures with max. dimension (e.g. 3000 pixel)
• If you do´nt want to create reduced pictures via thumb-feature of the Wiki-system, you will create and upload yourself. The pictures must have prefix: "_p" for preview (small), "_" for middle size. Our example:

ParameterIdentifikation-MeasurePlace.jpg
ParameterIdentifikation-MeasurePlace_.jpg
ParameterIdentifikation-MeasurePlace_p.jpg

• Attention: The individual creating of reduced pictures is relevant only for some cases. The quality of pictures generated by Wiki-system is very good. The size of created pictures is as double as the size of manual optimized pictures. For improved internet access, there is no problem.

[edit] Insert Picture in Text

Unfortunately, not all features described in the Wikipedia work correctly. E.g. the ImageMap-feature can´t installed. A direct linking of the pictures on another page is impossible.

Here, some options to link a picture:

Frameless preview with link on the original picture: The size of 100 pixel is selected. For correct use in text, 200 pixel should be used:

[[Image:Example.jpg|100px|pictinfo]] 

Standard position of the picture is in text line (only for most small pictures!)

[[Image:Example.jpg|100px|left||pictinfo]]

Image left in section

• .
• .
• .
• .

[[Image:Example.jpg|100px|right|pictinfo]]

Image right in section

• .
• .
• .
• .

[[Image:Example.jpg|100px|center|pictinfo]]

Image alone center of the line - because of printableversion, the following center is proposed:

<div align="center">[[Image:Example.jpg|100px|pictinfo]]</div>

Image alone center in the line

Standard preview with link on original picture with additional text and link:

[[Image:Example.jpg|thumb|pictinfo]]

Standard position ist right from section, additional text in frame:

• .
• .
• .
• .
• .
• .
• .
• .

[[Image:Example.jpg|thumb|center|At interesse:[[Simulation]]]]

the center alignment contains additional text and link. Text and link need a additional frame, because the symbol for resizing of pictures centers bottom in the frame. The disadvantage is that the text bottom in the frame will be displayed as info for the picture if the mouse move on this:

[[Image:Example.jpg|thumb|left|At interess:[[Simulation]]]]

left alignment with text and intern link

• .
• .
• .
• .
• .
• .
• .
• .
• .

Own Preview with Frame, Text and Link:

• The own preview can used instead of preview generated automatically. Its from and content must be agreed with the linked image. A center aligned preview can be gotten only by using own preview with |frame|:

[[Image:Example.jpg|thumb=Example_small.jpg|frame|center]]

• Or with additional text. The text should describes the image:

[[Image:Example.jpg|thumb=Example_small.jpg|frame|center|View of the Motor]]

• Or with additional text and link:

[[Image:Example.jpg|frame|thumb=Example_small.jpg|center|See also:[[Simulation]]]]

• Externe links are analogues:

[[Image:Example.jpg|frame|thumb=Example_small.jpg|center|Source: [http://www.ifte.de IFTE-TUD]]]

• Instead |center|, |left| or |right| can be used. The form ist herewith identical.

[edit] Additional Information for Image

Frequently, the image should offer ein entry to another page which deals the topic of the image. A link to another tex page is realized by missing the ImageMap feature at the link in frame of the preview described above.

A nonconventional solution within Wiki-system is to use the picture page generated automatically. Cklick on the picture lead directly to the page. The picture page can be edited normal as a text page. The additional information created automatically before and after the content inserted manual are very usefull.

These possibilities are sure usefull for a detailed description of experiment. To the page of the example Image:Example.jpg, only click on the preview of the image.