Differences

This shows you the differences between two versions of the page.

--- playground:playground [2017-12-07 21:06] – 84.52.151.232
+++ playground:playground [2024-04-12 15:14] (current) – [Table] 142.113.214.18
@@ Line 1: / Line 1: @@
-==== TEST ====
+== Basic text formatting ==
-===== TEST =====
+You can format the page using Wikitext special characters.
-======= TEST =======
-''**Users**''
+{| border="1" cellpadding="2" cellspacing="0"
+!width="1000"|What it looks like
+!width="500"|What you type
+|-
+|
+You can ''italicize'' text by putting 2
+apostrophes on ''each'' side.
-[[playground:teste.html|test]]
+apostrophes will '''bold''' the text.
-  * [[syntax#internal|User Object]]
-  * [[syntax#internal|GET users]]
-  * [[syntax#internal|GET users/:id]]
-  * [[syntax#internal|GET users/me]]
-  * [[syntax#internal|GET users/me/permissions]]
-  * [[syntax#internal|GET users/:id/accounts]]
-  * [[syntax#internal|POST users/new (will eventually be changed to 'POST users')]]
-  * [[syntax#internal|PUT users/:id]]
-  * [[syntax#internal|POST users/signup]]
-  * [[syntax#internal|POST users/resetpassword]]
-  * [[syntax#internal|POST users/password]]
-''** User Object **''
+apostrophes will '''''bold and italicize'''''
+the text.
-**''Description''**
+(Using 4 apostrophes doesn't do anything
+special -- <br /> 3 of them '''bold''' the text as
+usual; the others are ''''just'''' apostrophes
+around the text.)
-A direct user of the system. Could be an organization employee or customer.
+|
+You can ''italicize'' text by putting 2
+apostrophes on ''each'' side.
-''**Fields**''
+apostrophes will '''bold''' the text.
-^ Field       ^ Type      ^ Optional       ^ Subtypes      ^ Description       ^
+apostrophes will '''''bold and italicize'''''
-|    id       |           |                |               |                   |
+the text.
-|    email    |           |                |               |                   |
-|  fist name  |           |                |               |                   |
-|  last name  |           |                |               |                   |
-|   address   |           |                |               |                   |
-| organization|           |                |               |                   |
-|  is owner   |           |                |               |                   |
+(Using 4 apostrophes doesn't do anything
+special -- <br /> 3 of them '''bold''' the text as
+usual; the others are ''''just'''' apostrophes
+around the text.)
+</syntaxhighlight>
+|-
+|
+A single newline
+generally 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
+(used internally to compare
+different versions of a page).
-**''JSON Sample''**
+But an empty line
+starts a new paragraph.
-{
+When used in a list, a newline ''does'' affect the layout ([[#lists|see below]]).
-  "email" : "first.last@example.com",
+|<syntaxhighlight lang=wikitext>
-  "first_name" : "Doug",
+A single newline
-  "last_name" : "Kurth",
+generally has no effect on the layout.
-  "user_type" : "Customer",
+These can be used to separate
-  "is_professional" : false,
+sentences within a paragraph.
-  "id" : 12345,
+Some editors find that this aids editing
-  "is_active" : false
+and improves the ''diff'' function
-}
+(used internally to compare
+different versions of a page).
+But an empty line
+starts a new paragraph.
-**GET users**
+When used in a list, a newline ''does''
+affect the layout ([[#lists|see below]]).
+</syntaxhighlight>
+|-
+|
+You can break lines<br/>
+without a new paragraph.<br/>
+Please use this sparingly.
-**Description**
+Please do not start a link or ''italics'' or '''bold''' text on one line and end on the next.
+|<syntaxhighlight lang=wikitext>
+You can break lines<br/>
+without a new paragraph.<br/>
+Please use this sparingly.
-Get the details for all users visible by the requester
+Please do not start a link or
+''italics'' or '''bold''' text on one line
+and end on the next.
+</syntaxhighlight>
+|-
-**Resource URL**
+|You should "sign" your comments on talk pages: <br/>
-https://api.optionscity.com/users
+<div class="mw-notalk">
+* Three tildes gives your signature: [[User:Example|Example]] <br/>
-^Authentication	  |Required           |
+* Four tildes give your signature plus date/time: [[User:Example|Example]] 07:46, 27 November 2005 (UTC) <br/>
-^HTTP Methods	  |GET                |
+* Five tildes gives the date/time alone: 07:46, 27 November 2005 (UTC) <br/>
-^Media Types	  |application/json   |
+</div>
-^Response Object  |User               |
+|<syntaxhighlight lang=wikitext>
-^Response Type	  |Standard           |
+ You should "sign" your comments
+ on talk pages:
-**Parameters**
+ * Three tildes gives your
+ signature: ~~~
+ * Four tildes give your
+ signature plus date/time: ~~~~
+ * Five tildes gives the
+ date/time alone: ~~~~~
+</syntaxhighlight>
+|}
-^Name	    ^Description	                                       ^Required?	^Type       ^
-|page	    |1-indexed page to retrieve. Default is 1.	               |No	        |Number     |
-|per_page   |Number of entries returned per page. Default is 20.       |No              |Number     |
-|email	    |Get the user registered with this email address.	       |No              |String     |
-|query	    |Search for users matching this query by name              |No	        |String     |
-**Example Request**
-GET https://api.optionscity.com/users
-**Example Response**
-[ {
-  "email" : "first.last@example.com",
-  "first_name" : "Doug",
-  "last_name" : "Kurth",
-  "user_type" : "Customer",
-  "is_professional" : false,
-  "id" : 12345,
-  "is_active" : false
-} ]