Difference between revisions of "Help:Contents"

From WikiTI
Jump to: navigation, search
m (Tips && Hints)
 
(27 intermediate revisions by 13 users not shown)
Line 1: Line 1:
For further information/syntax, please refer to [http://en.wikipedia.org/wiki/Help:Contents Wikipedia's Help system].
+
For further information/syntax, please refer to [[wikipedia:Help:Contents|Wikipedia's Help System]].
 +
== Frequently Asked Questions ==
 +
=== 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.
  
 
== 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 ===
 
=== Getting Started ===
* '''Ok, I've logged in: how do I make a new page?'''
+
; Ok, I've logged in<nowiki>:</nowiki> 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:
+
: 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>
+
  83Plus:RAM:FFFF
* '''Do I need to denote hexadecimal with a $ or h, like in Z80 assembly?'''
+
:Make sure you read the [[Contributing|Contributing Guidelines]]!!!
** No, it is assumed in WikiTI that all numbers/addresses are hexidecimal by default.
+
;Do I need to denote hexadecimal with a $ or h, like in Z80 assembly?
* '''What are templates?'''
+
:No, it is assumed in WikiTI that all numbers/addresses are hexidecimal by default.
** 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).
+
;What are templates?
* '''How do I use a template?'''
+
: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).
** Select a template
+
; How do I use a template?
** View the source and copy it (the edit tab is near the top of the screen)
+
* Select a template
** Paste the source into your new page (that you just Goto'ed)
+
* View the source and copy it (the ''View source'' tab is near the top of the screen (this is NOT the same as telling your browser you'd like to view the HTML source of the page; this shows you the wiki source))
** Edit the text to fit your type of documentation
+
* Paste the source into your new page (that you just Goto'ed)
* '''What's the category text at the top of the templates for?'''
+
* Edit the text to fit your type of documentation
** That is how WikiTI categorizes the various pages.  Following the previous example, you should have these lines at the top of your new page:
+
; What's the category text at the top of the templates for?
  <nowiki>[Category:83Plus:RAM:By Address:FFFF - TheName]
+
: 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 Name|TheName]</nowiki>
+
  <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 :-)
+
:If you are curious as to how a page works, don't forget to view the source of it :-)
 +
;Can we only contribute undocumented information on the TI-OS?
 +
:Absolutely not. You can contribute whatever you like, because in the end, we'd like WikiTi to become a complete reference.  However, just make sure that you don't copy/paste other people's copyrighted documentation into the wiki unless you have permission to do so from the copyright holder.
  
 
=== Editing ===
 
=== Editing ===
* '''How do I make bold/italicized text?'''
+
; How do I make bold/italicized text?
** See [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page#Character_formatting Character Formatting]
+
: See [[wikipedia:Wikipedia:How_to_edit_a_page#Character_formatting|Character Formatting]].
* '''How do I make lists?'''
+
; 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]
+
: See [[wikipedia:Wikipedia:How_to_edit_a_page#Sections.2C_paragraphs.2C_lists_and_lines|Lists and Lines]].
* '''Argh!  The tab doesn't work!'''
+
; Argh!  The tab doesn't work!
** In Wikipedia, you use a colon : to indent a paragraph.
+
: In MediaWiki, you use a colon : to indent a paragraph.
* '''How do I put text in that blue border?'''
+
; 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:
+
: Use &lt;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 &lt;pre> in HTML.  So " &lt;nowiki>Your text here&lt;/nowiki>" will show:
 
  <nowiki>Your text here</nowiki>
 
  <nowiki>Your text here</nowiki>
* '''How do I make links?'''
+
; 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.
+
: That depends on the kind of link you want to make.  See [[wikipedia:Wikipedia:How_to_edit_a_page#Links_and_URLs|Links and URLs]] for a more in-depth discussion.
 +
; Is there a way I can get it to wrap at the end of the window, and yet still have a line break when I put a line break in the text?
 +
: Yes, put two line breaks in to get one on the page.
  
=== Recent Changes ===
+
== Tips &amp; Hints ==
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.
 
* 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).
+
* Mark minor changes as Minor Edits (see [[wikipedia: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.
+
As stated up above, please consult [[wikipedia:Help:Contents|Wikipedia's Help system]] for more information.

Latest revision as of 17:00, 31 July 2019

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

Frequently Asked Questions

Registering

How do I register/login?
In the upper-right hand corner of the screen, select 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 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
Make sure you read the Contributing Guidelines!!!
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 Templates for a list of templates).
How do I use a template?
  • Select a template
  • View the source and copy it (the View source tab is near the top of the screen (this is NOT the same as telling your browser you'd like to view the HTML source of the page; this shows you the wiki source))
  • 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:
[[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 :-)
Can we only contribute undocumented information on the TI-OS?
Absolutely not. You can contribute whatever you like, because in the end, we'd like WikiTi to become a complete reference. However, just make sure that you don't copy/paste other people's copyrighted documentation into the wiki unless you have permission to do so from the copyright holder.

Editing

How do I make bold/italicized text?
See Character Formatting.
How do I make lists?
See Lists and Lines.
Argh! The tab doesn't work!
In MediaWiki, 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>" will show:
Your text here
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.
Is there a way I can get it to wrap at the end of the window, and yet still have a line break when I put a line break in the text?
Yes, put two line breaks in to get one on the page.

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.