Help:Editing: Difference between revisions

Help page
(→‎Navigation boxes: clarifying functionality of navboxes)
(where to find more help)
Line 1: Line 1:
iPhoneDevWiki uses the same wiki markup as Wikipedia and other wikis that run on the MediaWiki software.
If you have questions about how to edit this wiki, feel free to ask in the #iphonedev IRC channel - see the [[IRC]] article for help, or use [https://kiwiirc.com/client/irc.saurik.com/#iphonedev this convenient web client for #iphonedev].
 
iPhoneDevWiki runs on the MediaWiki software, the same as Wikipedia and many other large wikis, so most help for editing Wikipedia/MediaWiki will apply here too.
 
== Help with markup (page editing syntax) ==


'''[https://en.wikipedia.org/wiki/Help:Cheatsheet See Wikipedia's formatting cheatsheet]''' for how to do general wiki markup (italics, bold, links, images, and so on).
'''[https://en.wikipedia.org/wiki/Help:Cheatsheet See Wikipedia's formatting cheatsheet]''' for how to do general wiki markup (italics, bold, links, images, and so on).
Line 5: Line 9:
For help making tables, see [https://www.mediawiki.org/wiki/Help:Tables MediaWiki's table formatting page].
For help making tables, see [https://www.mediawiki.org/wiki/Help:Tables MediaWiki's table formatting page].


== Making new pages ==
== How to make new articles (new pages) ==


An easy way to make a new article: type your desired article title into the search box, and click the "Create the page" link on the search results page. Then type in the content that you want, and save it.
An easy way to make a new article: type your desired article title into the search box, and click the "Create the page" link on the search results page. Then type in the content that you want, and save it.


== Syntax highlighting ==
== Fancy syntax highlighting ==


You can make code snippets nicely syntax-highlighted using these tags:
You can make code snippets nicely syntax-highlighted using these tags:
Line 25: Line 29:
This wiki uses [http://qbnz.com/highlighter/ GeSHi] as the syntax highlighter. It supports [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages many] languages such as <code>bash, c, cpp, text</code>.
This wiki uses [http://qbnz.com/highlighter/ GeSHi] as the syntax highlighter. It supports [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages many] languages such as <code>bash, c, cpp, text</code>.


== Navigation boxes ==
== How to add a navigation box to the bottom of an article ==


To add a helpful navigation box to the bottom of an article documenting a class, you can use tags like these:
To add a helpful navigation box to the bottom of an article documenting a class, you can use tags like these:

Revision as of 01:05, 30 April 2014

If you have questions about how to edit this wiki, feel free to ask in the #iphonedev IRC channel - see the IRC article for help, or use this convenient web client for #iphonedev.

iPhoneDevWiki runs on the MediaWiki software, the same as Wikipedia and many other large wikis, so most help for editing Wikipedia/MediaWiki will apply here too.

Help with markup (page editing syntax)

See Wikipedia's formatting cheatsheet for how to do general wiki markup (italics, bold, links, images, and so on).

For help making tables, see MediaWiki's table formatting page.

How to make new articles (new pages)

An easy way to make a new article: type your desired article title into the search box, and click the "Create the page" link on the search results page. Then type in the content that you want, and save it.

Fancy syntax highlighting

You can make code snippets nicely syntax-highlighted using these tags:

<source lang=objc>
NSObject *anObject = [[NSObject alloc] init];
</source>

Which will produce an output that looks like the following:

 NSObject *anObject = [[NSObject alloc] init];

This wiki uses GeSHi as the syntax highlighter. It supports many languages such as bash, c, cpp, text.

How to add a navigation box to the bottom of an article

To add a helpful navigation box to the bottom of an article documenting a class, you can use tags like these:

{{occlass|library=SpringBoard.app|navbox=1}}
{{occlass|library=CoreFoundation.framework|navbox=1}}

If you add this navigation box to an article, the article link will automatically show up within that navigation box.