Learn more about it

From MicroFocusInternationalWiki
Jump to: navigation, search

The Micro Focus International Wiki is a Best Practices Compendium written collaboratively by its readers. You're welcome to add to articles, or start new ones. You are even free to copy, change or distribute articles.

How Do I Edit a Page?

Editing a Wiki page is very easy. Simply click on the "Edit" tab at the top of a Wiki page. This will bring you to a page with a text box containing the editable text of that page. If you want to experiment, go try it on this sample page. When you've finished, press "Show preview" to see how your changes will look. If you're happy with what you see, then press "Save" and your changes will be immediately applied to the article.

You can also click on the "Discussion" tab to see the corresponding "Talk" page, which contains comments about the page from other Cool Wiki users. Click on the "+" tab or "Edit this page") to add a comment.

Please do not vandalize the other articles in the Cool Wiki-- it's a waste of time for everyone, and generally considered to be in the worst of taste.

Change Control

Wikis generally follow a philosophy of making it easy to fix mistakes, rather than making it hard to make them. Thus, while wikis are very open, they also provide various means to verify the validity of recent additions to the body of pages. The most prominent one on almost every wiki is the so-called Recent Changes page, which displays a list of either a specific number of recent edits or a list of all edits that have been made within a given timeframe. Some wikis allow the list to be filtered so that minor edits - or edits that have been made by automatic importing scripts ("bots") - can be excluded.

From the change log, two other functions are accessible in most wikis: the revision history, which shows previous versions of the page, and the diff feature, which can highlight the changes between two revisions. The revision history allows an editor to open and save a previous version of the page and thereby restore the original content. The diff feature can be used to decide whether this is necessary or not. A regular user of the wiki can view the diff of a change listed on the "Recent changes" page and, if it is an unacceptable edit, consult the history to restore a previous revision.

Minor edits

When editing a page, a logged-in user has the option of flagging the edit as a "minor edit". When to use this is somewhat a matter of personal preference. The rule of thumb is that an edit of a page that is spelling corrections, formatting, and minor rearranging of text should be flagged as a "minor edit". A major edit is basically something that makes the entry worth relooking at for somebody who wants to watch the article rather closely, so any "real" change, even if it is a single word. This feature is important, because users can choose to hide minor edits in their view of the Recent Changes page, to keep the volume of edits down to a manageable level.

The reason for not allowing a user who is not logged in to mark an edit as minor is that vandalism could then be marked as a minor edit, in which case it would stay unnoticed longer. This limitation is another reason to log in.

Summary field for edits

When you edit a page in the wiki, you should take a minute with each revision to provide a short summary in the Summary field about what the changes you made are. This significantly helps someone else to get a quick overview of the changes made to a page. It is very "un-user-friendly" to see a long list of versions without any idea what was changed in each revision unless you use the "diff" function.

The wiki markup

In the left column of the table below, you can see what effects are possible. In the right column, you can see how those effects were achieved. In other words, to make text look like it looks in the left column, type it in the format you see in the right column.

You may want to keep this page open in a separate browser window for reference. If you want to try out things without danger of doing any harm, you can do so in the Sandbox.

Sections, paragraphs, lists and lines

What it looks like What you type

Start your sections with header lines:

New section

Subsection

Sub-subsection


== New section ==
       or
<h3> New section </h3>

=== Subsection ===
       or
<h4> Subsection </h4>

==== Sub-subsection ====
       or
<h5> Sub-subsection </h5>

A single newline has no effect on the layout. These can be used to separate sentences within a paragraph. Some editors find that this aids editing and improves the diff function.

But an empty line starts a new paragraph.

A single newline
has no effect on the layout.
These can be used to separate
sentences within a paragraph.
Some editors find that this aids editing
and improves the ''diff'' function.

But an empty line
starts a new paragraph.
You can break lines
without starting a new paragraph.
You can break lines<br>
without starting a new paragraph.
  • Lists are easy to do:
    • start every line with a star
    • more stars means deeper levels
* Lists are easy to do:
** start every line with a star
** more stars means deeper levels
  1. Numbered lists are also good
    1. very organized
    2. easy to follow
# Numbered lists are also good
## very organized
## easy to follow
  • You can even do mixed lists
    1. and nest them
      • like this
* You can even do mixed lists
*# and nest them
*#* like this
Definition list 
definition (1)
definition (2)
definition (3)
; Definition list : definition (1) 
: definition (2)
: definition (3)
  • One item per line, NEWLINE only before the colon. The space

before the colon improves parsing.

A colon indents a line or paragraph.

A manual newline starts a new paragraph.

: A colon indents a line or paragraph.
A manual newline starts a new paragraph.
IF a line starts with a space THEN
  it will be formatted exactly
    as typed;
  in a fixed-width font;
  lines won't wrap;
ENDIF
this is useful for:
  * pasting preformatted text;
  * algorithm descriptions;
  * program source code
  * ascii art;

WARNING If you make it wide, you force the whole page to be wide and hence less readable. Never start ordinary lines with spaces.

 IF a line starts with a space THEN
   it will be formatted exactly
     as typed;
   in a fixed-width font;
   lines won't wrap;
 ENDIF
 this is useful for:
   * pasting preformatted text;
   * algorithm descriptions;
   * program source code
   * ascii art;
Centered text.
<center>Centered text.</center>
A horizontal dividing line: above

and below.

Useful for separating threads on Talk pages.

A horizontal dividing line: above
----
and below. 



Links, URLs

.
What it looks like What you type

To reference other WIKI pages, enclose the page name with double square brackets. For example Novell Industry Standards and Initiatives.

To reference other WIKI pages, enclose the page name
with double square brackets. 
For example [[Novell Industry Standards and Initiatives]].

Trivia:

  • If the referenced page does not exist the words will be highlighted in red
    • You can create it by clicking on the link.
  • Internally WIKI converts the spaces between words into underscores.
  • First letter of target is automatically capitalized.

Link to a section on a page, e.g. Novell Industry Standards and Initiatives#Calendar (links to non-existent sections aren't really broken, they are treated as

links to the page, i.e. to the top)
[[Novell Industry Standards and Initiatives#Calendar]]
To have a different name displayed:

Open Source Community of Practice.

To have a different name displayed:
[[CoP - Open Source |Open Source Community of Practice]].
Endings are blended into the link: testing, genes
Endings are blended
into the link: [[test]]ing, [[gene]]s
When adding a comment to a Talk page,

you should sign it. You can do this by adding three tildes for your user name:

Alan Clark

or four for user name plus date/time:

Alan Clark 08:10 Oct 5, 2002 (UTC)
When adding a comment to a Talk page,
you should sign it. You can do this by
adding three tildes for your user name:
: ~~~
or four for user name plus date/time:
: ~~~~
The weather in London is a page that doesn't

exist yet.

  • You can create it by clicking on the link.
  • To create a new page:
    1. Create a link to it on some other page.
    2. Save that page.
    3. Click on the link you just made. The new page will open for editing.
  • Have a look at how to start a page guide and

the naming conventions page for your project.

  • After creating a page, search for its title and make sure that

everyone correctly links to it.

[[The weather in London]] is a page
that doesn't exist yet.

Redirect one article title to another by putting text like this (#Redirect) in its first line.

#REDIRECT [[United States]]

For a special way to link to the page on the same subject in another language or on another wiki, see MediaWiki User's Guide: Interwiki linking.

[[MediaWiki User's Guide: Interwiki linking]]
External Links: Novell
External Links: [http://www.novell.com Novell] 
Or just give the URL: http://www.novell.com.
  • In the URL all symbols must be among: A-Z a-z 0-9 ._\/~%-+&#?!=()@ \x80-\xFF.

If a URL contains a different character it should be converted; for example, ^ has to be written %5E (to be looked up in ASCII).

Or just give the URL:
http://www.novell.com.


Images, Media

What it looks like What you type
A picture: The Novell Icon
  • Only images that have been uploaded to Wikibooks can be used. To upload

images, use the upload page. You can find the uploaded image on the image list

A picture: [[Image:Nov_red.gif]]

or, with alternate text (strongly encouraged)

[[Image:Nov_red.gif|The Novell Icon]] 

Web browsers render alternate text when not displaying an image -- for example, when the image isn't loaded, or in a text-only browser, or when spoken aloud.

Clicking on an uploaded image displays a description page, which you can also link directly to: Image:Nov_red.gif

[[:Image:Nov_red.gif]]

To include links to non-image uploads such as sounds, or to images shown

as links instead of drawn on the page, use a "media" link.


Penguin Vs. Butterfly Video

Idm Point

Securing NW Word Doc.

PKI PDF


[[media:Penguin_vs_butterfly_real.ram| Penguin Vs. Butterfly Video]]
[[media:Identity_and_Provisioning_Applications_and_Management_Roadmap_rev.ppt
 | Identity and Provisioning Power Point]]
[[media:Securing_Netware_Standard_FINAL.doc| Securing NetWare Word Document]]
[[media:Pki_directory_pp.pdf | PKI PDF]]

To link to books, you can use ISBN links. ISBN 0123456789X See MediaWiki User's Guide: ISBN links

ISBN 0123456789X

"What links here" and "Related changes" can be linked as:

Special:Whatlinkshere/How to edit a page and Special:Recentchangeslinked/How to edit a page

[[Special:Whatlinkshere/How to edit a page]] and [[Special:Recentchangeslinked/How to edit a page]]


Tables

There are 2 syntaxes available for table creation.

  1. Wiki has it's own markup. An example would be to look at

the calendar on the Novell Industry Standards and Initiatives page.

  1. Some of the usual html elements are also available. To see how

tables are created using html elements, look at the source for this page.


Character formatting

What it looks like What you type

Emphasize, strongly, very strongly.

  • These are double and triple apostrophes, not double quotes.
''Emphasize'', '''strongly''',
'''''very strongly'''''.

You can also write italic and bold if the desired effect is a specific font style rather than emphasis, as in mathematical formulae:

F = ma
  • However, the difference between these two methods is not
very important for graphical browsers, and many people 

choose to ignore it.

You can also write <i>italic</i> and <b>bold</b>
if the desired effect is a specific font style
rather than emphasis, as in mathematical formulas:
:<b>F</b> = <i>m</i><b>a</b>
A typewriter font for technical terms.
A typewriter font for <tt>technical terms</tt>.
You can use small text for captions.
You can use <small>small text</small> for captions.
You can strike out deleted material

and underline new material.

You can <strike>strike out deleted material</strike>
and <u>underline new material</u>.

Umlauts and accents: (See MediaWiki User's Guide: Creating special characters)
è é ê ë ÃƒÂ¬ í

À �? Â Ã Ä Å
Æ Ç È É Ê Ë
Ì �? Î �? Ñ Ò
Ó Ô Õ Ö Ø Ù
Ú Û Ü ß à á
â ã ä å æ ç
è é ê ë ÃƒÂ¬ í
î ï ñ ò ó ô
œ õ ö ø ù ú
û ü ÿ


è é ê ë ÃƒÂ¬ í

À �? Â Ã Ä Å
Æ Ç È É Ê Ë
Ì �? Î �? Ñ Ò
Ó Ô Õ Ö Ø Ù
Ú Û Ü ß à á
â ã ä å æ ç
è é ê ë ÃƒÂ¬ í
î ï ñ ò ó ô
œ õ ö ø ù ú
û ü ÿ

Punctuation:
¿ ¡ « Ã‚» § ¶
† ‡ • —

¿ ¡ « Ã‚» § ¶
† ‡ • —

Commercial symbols:
™ © ® ¢ € ¥

£ ¤
™ © ® ¢ € ¥
£ ¤
Subscript: x2

Superscript: x2 or x²

  • The latter method of superscript can't be used in the most general context, but is preferred when possible (as with units of measurement) because most browsers have an easier time formatting lines with it.

ε0 = 8.85 × 10−12 C² / J m.

1 hectare = 1 E4 m²

Subscript: x<sub>2</sub>
Superscript: x<sup>2</sup> or x²
ε<sub>0</sub> =
8.85 × 10<sup>−12</sup>
C² / J m.

1 [[hectare]] = [[1 E4 m²]]
Greek characters:

α β γ δ ε ζ
η θ ι κ λ μ ν
ξ ο π ρ σ ς
τ υ φ χ ψ ω
Γ Δ Θ Λ Ξ Π
Σ Φ Ψ Ω

α β γ δ ε ζ
η θ ι κ λ μ ν
ξ ο π ρ  σ ς
τ υ φ χ ψ ω
Γ Δ Θ Λ Ξ Π
Σ Φ Ψ Ω

Math characters:
∫ ∑ ∏ √ − ± ∞
≈ ∝ ≡ ≠ ≤ ≥ →
× · ÷ ∂ ′ ″
∇ ‰ ° ∴ ℵ ø
∈ ∉ ∩ ∪ ⊂ ⊃ ⊆ ⊇
¬ ∧ ∨ ∃ ∀ ⇒ ⇔
→ ↔

∫ ∑ ∏ √ − ± ∞
≈ ∝ ≡ ≠ ≤ ≥ →
× · ÷ ∂ ′ ″
∇ ‰ ° ∴ ℵ ø
∈ ∉ ∩ ∪ ⊂ ⊃ ⊆ ⊇
¬ ∧ ∨ ∃ ∀ ⇒ ⇔
→ ↔
x2 ≥ 0 true.
  • To space things out, use non-breaking spaces - .
  • also prevents line breaks in the middle of text, this is useful in formulas.
<i>x</i><sup>2</sup>  ≥  0 true.

Complicated formulae:

 <math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>
<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>

Suppressing interpretation of markup:
Link → (<i>to</i>) the [[FAQ]]

  • Used to show literal data that would otherwise have special meaning.
  • Escapes all wiki markup, including that which looks like HTML tags.
  • Does not escape HTML character entities.
<nowiki>Link → (<i>to</i>)
the [[FAQ]]</nowiki>

Commenting page source:
not shown in page

  • Used to leave comments in a page for future editors.
<!-- comment here -->


Variables

CodeEffect
{{CURRENTMONTH}} 10
{{CURRENTMONTHNAME}} October
{{CURRENTMONTHNAMEGEN}} October
{{CURRENTDAY}} 16
{{CURRENTDAYNAME}} Tuesday
{{CURRENTYEAR}} 2018
{{CURRENTTIME}} 22:46
{{NUMBEROFARTICLES}} 624
__NOTOC__ No Table of Contents
__NOEDITSECTION__ Page edits only

NUMBEROFARTICLES: number of pages in the main namespace which contain a link and are not a redirect, i.e. number of articles, stubs containing a link, and disambiguation pages).

Page protection

In a few cases the link labeled "Template:Editthispage" is replaced by the text "Template:Protectedpage" (or equivalents in the language of the project). In that case the page can not be edited.

Editing using an external editor

A web browser's text area editing capabilities can be quite constricting when making frequent or larger edits. Some browsers can be configured to allow text area editing using an external editor like vi, emacs, kwrite or wordpad.exe.

Mozilla Firefox

The ViewSourceWith Firefox Extension allows the use of an external editor.