Difference between revisions of "Help:Contents"

From WikiTI
Jump to: navigation, search
 
Line 1: Line 1:
Until we have the time to make our own help system, please refer to [http://en.wikipedia.org/wiki/Help:Contents Wikipedia's Help system].
+
For further information/syntax, please refer to [http://en.wikipedia.org/wiki/Help:Contents Wikipedia's Help system].
 +
 
 +
 
 +
== FAQ ==
 +
=== Registering ===
 +
# '''How do I register/login?'''
 +
#* In the upper-right hand corner of the screen, select [[Special:Userlogin| Create a user or login]].
 +
# '''Do I need to provide my real name?'''
 +
#* No, it is a matter of personal preference/privacy to provide your real name.
 +
# '''Can I change it later?'''
 +
#* Yes, once you login, you can change your password, real name, and e-mail address.
 +
 
 +
=== Getting Started ===
 +
# '''Ok, I've logged in:  how do I make a new page?'''
 +
#* Type the name in the Goto box on the left-hand side of the screen; see [[Contributing| Contributing Guidelines]] for the syntax.  As an example, if you want to add documentation for RAM address FFFF on the 83+, type the following in the Goto box:
 +
<nowiki>83Plus:RAM:FFFF</nowiki>
 +
# '''Do I need to denote hexadecimal with a $ or h, like in Z80 assembly?'''
 +
#* No, it is assumed in WikiTI that all numbers/addresses are hexidecimal by default.
 +
# '''What are templates?'''
 +
#* Templates, are, as the name says, templates :)  They provide a default structure for the various pages.  If all the WikiTI users follow these templates, it'll make all B_CALL pages look consistent, all ports the same format, etc.  Thus, it is encouraged to use these (see [[ Contributing#Templates| Templates]] for a list of templates).
 +
# '''How do I use a template?'''
 +
## Select a template
 +
## View the source and copy it (the edit tab is near the top of the screen)
 +
## Paste the source into your new page (that you just Goto'ed)
 +
## Edit the text to fit your type of documentation
 +
# '''What's the category text at the top of the templates for?'''
 +
#* That is how WikiTI categorizes the various pages.  Following the previous example, you should have these lines at the top of your new page:
 +
<nowiki>[Category:83Plus:RAM:By Address:FFFF - TheName]
 +
[Category:83Plus:RAM:By Name|TheName]</nowiki>
 +
 
 +
If you are curious as to how a page works, don't forget to view the source of it :-)
 +
 
 +
=== Editing ===
 +
# '''How do I make bold/italicized text?'''
 +
#* See [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page#Character_formatting Character Formatting]
 +
# '''How do I make lists?'''
 +
#* See [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page#Sections.2C_paragraphs.2C_lists_and_lines Lists and Lines]
 +
# '''Argh!  The tab doesn't work!'''
 +
#* In Wikipedia, you use a colon : to indent a paragraph.
 +
# '''How do I put text in that blue border?'''
 +
#* Use <nowiki> preceded with a space.  The leading space tells the Wiki parser to display the text as a preformatted, fixed-width font, which is analogous to <pre> in HTML.  So " <nowiki>Your text here</nowiki></nowiki>" will show:
 +
<nowiki>Your text here</nowiki>
 +
# '''How do I make links?'''
 +
#* That depends on the kind of link you want to make.  See [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page#Links_and_URLs Links and URLs] for a more in-depth discussion.
 +
 
 +
=== Recent Changes ===
 +
None at this time
 +
 
 +
=== Browsing ===
 +
# '''Why does my contribution not show up in the list?'''
 +
#* Most likely, you are viewing a cached version of WikiTI.  Try clearing out your cache (browser-specific).  Alternatively, you may wish to disable caching in your preferences.
 +
 
 +
=== Advanced ===
 +
None at this time
 +
 
 +
== Tips && Hints ==
 +
* Use the Preview Button to view your changes before you Save.
 +
* Mark minor changes as Minor Edits (see [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page#Minor_edits Minor Edits] as to what constitutes a Minor Edit).
 +
 
 +
 
 +
As stated up above, please consult [http://en.wikipedia.org/wiki/Help:Contents Wikipedia's Help system] for more information.

Revision as of 14:54, 3 April 2005

For further information/syntax, please refer to Wikipedia's Help system.


FAQ

Registering

  1. How do I register/login?
  2. Do I need to provide my real name?
    • No, it is a matter of personal preference/privacy to provide your real name.
  3. Can I change it later?
    • Yes, once you login, you can change your password, real name, and e-mail address.

Getting Started

  1. Ok, I've logged in: how do I make a new page?
    • Type the name in the Goto box on the left-hand side of the screen; see Contributing Guidelines for the syntax. As an example, if you want to add documentation for RAM address FFFF on the 83+, type the following in the Goto box:
83Plus:RAM:FFFF
  1. Do I need to denote hexadecimal with a $ or h, like in Z80 assembly?
    • No, it is assumed in WikiTI that all numbers/addresses are hexidecimal by default.
  2. What are templates?
    • Templates, are, as the name says, templates :) They provide a default structure for the various pages. If all the WikiTI users follow these templates, it'll make all B_CALL pages look consistent, all ports the same format, etc. Thus, it is encouraged to use these (see Templates for a list of templates).
  3. How do I use a template?
    1. Select a template
    2. View the source and copy it (the edit tab is near the top of the screen)
    3. Paste the source into your new page (that you just Goto'ed)
    4. Edit the text to fit your type of documentation
  4. What's the category text at the top of the templates for?
    • That is how WikiTI categorizes the various pages. Following the previous example, you should have these lines at the top of your new page:
[Category:83Plus:RAM:By Address:FFFF - TheName]
[Category:83Plus:RAM:By Name|TheName]

If you are curious as to how a page works, don't forget to view the source of it :-)

Editing

  1. How do I make bold/italicized text?
  2. How do I make lists?
  3. Argh! The tab doesn't work!
    • In Wikipedia, you use a colon : to indent a paragraph.
  4. How do I put text in that blue border?
    • Use preceded with a space. The leading space tells the Wiki parser to display the text as a preformatted, fixed-width font, which is analogous to <pre> in HTML. So " <nowiki>Your text here</nowiki>" will show:
Your text here
  1. How do I make links?
    • That depends on the kind of link you want to make. See Links and URLs for a more in-depth discussion.

Recent Changes

None at this time

Browsing

  1. Why does my contribution not show up in the list?
    • Most likely, you are viewing a cached version of WikiTI. Try clearing out your cache (browser-specific). Alternatively, you may wish to disable caching in your preferences.

Advanced

None at this time

Tips && Hints

  • Use the Preview Button to view your changes before you Save.
  • Mark minor changes as Minor Edits (see Minor Edits as to what constitutes a Minor Edit).


As stated up above, please consult Wikipedia's Help system for more information.