doc: Unified global router variable naming

content/en/docs/examples/ascii-json.md

@@ -7,9 +7,9 @@ Using AsciiJSON to Generates ASCII-only JSON with escaped non-ASCII characters.
 
 ```go
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 
-	r.GET("/someJSON", func(c *gin.Context) {
+	router.GET("/someJSON", func(c *gin.Context) {
 		data := map[string]interface{}{
 			"lang": "GO语言",
 			"tag":  "<br>",
@@ -20,6 +20,6 @@ func main() {
 	})
 
 	// Listen and serve on 0.0.0.0:8080
-	r.Run(":8080")
+	router.Run(":8080")
 }
 ```

content/en/docs/examples/bind-form-data-request-with-custom-struct.md

@@ -55,12 +55,12 @@ func GetDataD(c *gin.Context) {
 }
 
 func main() {
-    r := gin.Default()
-    r.GET("/getb", GetDataB)
-    r.GET("/getc", GetDataC)
-    r.GET("/getd", GetDataD)
+    router := gin.Default()
+    router.GET("/getb", GetDataB)
+    router.GET("/getc", GetDataC)
+    router.GET("/getd", GetDataD)
 
-    r.Run()
+    router.Run()
 }
 ```
 

content/en/docs/examples/bind-single-binary-with-template.md

@@ -14,12 +14,12 @@ func main() {
 	if err != nil {
 		panic(err)
 	}
-	r.SetHTMLTemplate(t)
+	router.SetHTMLTemplate(t)
 
-	r.GET("/", func(c *gin.Context) {
+	router.GET("/", func(c *gin.Context) {
 		c.HTML(http.StatusOK, "/html/index.tmpl", nil)
 	})
-	r.Run(":8080")
+	router.Run(":8080")
 }
 
 // loadTemplate loads templates embedded by go-assets-builder

content/en/docs/examples/custom-middleware.md

@@ -27,17 +27,17 @@ func Logger() gin.HandlerFunc {
 
 func main() {
 	r := gin.New()
-	r.Use(Logger())
+	router.Use(Logger())
 
-	r.GET("/test", func(c *gin.Context) {
+	router.GET("/test", func(c *gin.Context) {
 		example := c.MustGet("example").(string)
 
 		// it would print: "12345"
 		log.Println(example)
 	})
 
 	// Listen and serve on 0.0.0.0:8080
-	r.Run(":8080")
+	router.Run(":8080")
 }
 ```
 

content/en/docs/examples/define-format-for-the-log-of-routes.md

@@ -21,24 +21,24 @@ import (
 )
 
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 	gin.DebugPrintRouteFunc = func(httpMethod, absolutePath, handlerName string, nuHandlers int) {
 		log.Printf("endpoint %v %v %v %v\n", httpMethod, absolutePath, handlerName, nuHandlers)
 	}
 
-	r.POST("/foo", func(c *gin.Context) {
+	router.POST("/foo", func(c *gin.Context) {
 		c.JSON(http.StatusOK, "foo")
 	})
 
-	r.GET("/bar", func(c *gin.Context) {
+	router.GET("/bar", func(c *gin.Context) {
 		c.JSON(http.StatusOK, "bar")
 	})
 
-	r.GET("/status", func(c *gin.Context) {
+	router.GET("/status", func(c *gin.Context) {
 		c.JSON(http.StatusOK, "ok")
 	})
 
 	// Listen and Server in http://0.0.0.0:8080
-	r.Run()
+	router.Run()
 }
 ```

content/en/docs/examples/goroutines-inside-a-middleware.md

@@ -7,9 +7,9 @@ When starting new Goroutines inside a middleware or handler, you **SHOULD NOT**
 
 ```go
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 
-	r.GET("/long_async", func(c *gin.Context) {
+	router.GET("/long_async", func(c *gin.Context) {
 		// create copy to be used inside the goroutine
 		cCp := c.Copy()
 		go func() {
@@ -21,7 +21,7 @@ func main() {
 		}()
 	})
 
-	r.GET("/long_sync", func(c *gin.Context) {
+	router.GET("/long_sync", func(c *gin.Context) {
 		// simulate a long task with time.Sleep(). 5 seconds
 		time.Sleep(5 * time.Second)
 
@@ -30,6 +30,6 @@ func main() {
 	})
 
 	// Listen and serve on 0.0.0.0:8080
-	r.Run(":8080")
+	router.Run(":8080")
 }
 ```

content/en/docs/examples/html-rendering.md

@@ -93,9 +93,9 @@ func main() {
 You may use custom delims
 
 ```go
-	r := gin.Default()
-	r.Delims("{[{", "}]}")
-	r.LoadHTMLGlob("/path/to/templates")
+	router := gin.Default()
+	router.Delims("{[{", "}]}")
+	router.LoadHTMLGlob("/path/to/templates")
 ```
 
 ### Custom Template Funcs

content/en/docs/examples/http2-server-push.md

@@ -28,11 +28,11 @@ var html = template.Must(template.New("https").Parse(`
 `))
 
 func main() {
-	r := gin.Default()
-	r.Static("/assets", "./assets")
-	r.SetHTMLTemplate(html)
+	router := gin.Default()
+	router.Static("/assets", "./assets")
+	router.SetHTMLTemplate(html)
 
-	r.GET("/", func(c *gin.Context) {
+	router.GET("/", func(c *gin.Context) {
 		if pusher := c.Writer.Pusher(); pusher != nil {
 			// use pusher.Push() to do server push
 			if err := pusher.Push("/assets/app.js", nil); err != nil {
@@ -45,7 +45,7 @@ func main() {
 	})
 
 	// Listen and Serve in https://127.0.0.1:8080
-	r.RunTLS(":8080", "./testdata/server.pem", "./testdata/server.key")
+	router.RunTLS(":8080", "./testdata/server.pem", "./testdata/server.key")
 }
 ```
 

content/en/docs/examples/jsonp.md

@@ -7,9 +7,9 @@ Using JSONP to request data from a server  in a different domain. Add callback t
 
 ```go
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 
-	r.GET("/JSONP?callback=x", func(c *gin.Context) {
+	router.GET("/JSONP?callback=x", func(c *gin.Context) {
 		data := map[string]interface{}{
 			"foo": "bar",
 		}
@@ -20,6 +20,6 @@ func main() {
 	})
 
 	// Listen and serve on 0.0.0.0:8080
-	r.Run(":8080")
+	router.Run(":8080")
 }
 ```

content/en/docs/examples/pure-json.md

@@ -8,23 +8,23 @@ This feature is unavailable in Go 1.6 and lower.
 
 ```go
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 
 	// Serves unicode entities
-	r.GET("/json", func(c *gin.Context) {
+	router.GET("/json", func(c *gin.Context) {
 		c.JSON(200, gin.H{
 			"html": "<b>Hello, world!</b>",
 		})
 	})
 
 	// Serves literal characters
-	r.GET("/purejson", func(c *gin.Context) {
+	router.GET("/purejson", func(c *gin.Context) {
 		c.PureJSON(200, gin.H{
 			"html": "<b>Hello, world!</b>",
 		})
 	})
 
 	// listen and serve on 0.0.0.0:8080
-	r.Run(":8080")
+	router.Run(":8080")
 }
 ```

content/en/docs/examples/redirects.md

@@ -6,27 +6,27 @@ draft: false
 Issuing a HTTP redirect is easy. Both internal and external locations are supported.
 
 ```go
-r.GET("/test", func(c *gin.Context) {
+router.GET("/test", func(c *gin.Context) {
 	c.Redirect(http.StatusMovedPermanently, "http://www.google.com/")
 })
 ```
 
 Issuing a HTTP redirect from POST. Refer to issue: [#444](https://github.com/gin-gonic/gin/issues/444)
 
 ```go
-r.POST("/test", func(c *gin.Context) {
+router.POST("/test", func(c *gin.Context) {
 	c.Redirect(http.StatusFound, "/foo")
 })
 ```
 
 Issuing a Router redirect, use `HandleContext` like below.
 
 ``` go
-r.GET("/test", func(c *gin.Context) {
+router.GET("/test", func(c *gin.Context) {
     c.Request.URL.Path = "/test2"
-    r.HandleContext(c)
+    router.HandleContext(c)
 })
-r.GET("/test2", func(c *gin.Context) {
+router.GET("/test2", func(c *gin.Context) {
     c.JSON(200, gin.H{"hello": "world"})
 })
 ```

content/en/docs/examples/rendering.md

@@ -5,14 +5,14 @@ draft: false
 
 ```go
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 
 	// gin.H is a shortcut for map[string]interface{}
-	r.GET("/someJSON", func(c *gin.Context) {
+	router.GET("/someJSON", func(c *gin.Context) {
 		c.JSON(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
 	})
 
-	r.GET("/moreJSON", func(c *gin.Context) {
+	router.GET("/moreJSON", func(c *gin.Context) {
 		// You also can use a struct
 		var msg struct {
 			Name    string `json:"user"`
@@ -27,15 +27,15 @@ func main() {
 		c.JSON(http.StatusOK, msg)
 	})
 
-	r.GET("/someXML", func(c *gin.Context) {
+	router.GET("/someXML", func(c *gin.Context) {
 		c.XML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
 	})
 
-	r.GET("/someYAML", func(c *gin.Context) {
+	router.GET("/someYAML", func(c *gin.Context) {
 		c.YAML(http.StatusOK, gin.H{"message": "hey", "status": http.StatusOK})
 	})
 
-	r.GET("/someProtoBuf", func(c *gin.Context) {
+	router.GET("/someProtoBuf", func(c *gin.Context) {
 		reps := []int64{int64(1), int64(2)}
 		label := "test"
 		// The specific definition of protobuf is written in the testdata/protoexample file.
@@ -49,6 +49,6 @@ func main() {
 	})
 
 	// Listen and serve on 0.0.0.0:8080
-	r.Run(":8080")
+	router.Run(":8080")
 }
 ```

content/en/docs/examples/secure-json.md

@@ -7,19 +7,19 @@ Using SecureJSON to prevent json hijacking. Default prepends `"while(1),"` to re
 
 ```go
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 
 	// You can also use your own secure json prefix
-	// r.SecureJsonPrefix(")]}',\n")
+	// router.SecureJsonPrefix(")]}',\n")
 
-	r.GET("/someJSON", func(c *gin.Context) {
+	router.GET("/someJSON", func(c *gin.Context) {
 		names := []string{"lena", "austin", "foo"}
 
 		// Will output  :   while(1);["lena","austin","foo"]
 		c.SecureJSON(http.StatusOK, names)
 	})
 
 	// Listen and serve on 0.0.0.0:8080
-	r.Run(":8080")
+	router.Run(":8080")
 }
 ```

content/en/docs/examples/support-lets-encrypt.md

@@ -16,10 +16,10 @@ import (
 )
 
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 
 	// Ping handler
-	r.GET("/ping", func(c *gin.Context) {
+	router.GET("/ping", func(c *gin.Context) {
 		c.String(200, "pong")
 	})
 
@@ -41,10 +41,10 @@ import (
 )
 
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 
 	// Ping handler
-	r.GET("/ping", func(c *gin.Context) {
+	router.GET("/ping", func(c *gin.Context) {
 		c.String(200, "pong")
 	})
 

content/en/docs/examples/using-basicauth-middleware.md

@@ -12,11 +12,11 @@ var secrets = gin.H{
 }
 
 func main() {
-	r := gin.Default()
+	router := gin.Default()
 
 	// Group using gin.BasicAuth() middleware
 	// gin.Accounts is a shortcut for map[string]string
-	authorized := r.Group("/admin", gin.BasicAuth(gin.Accounts{
+	authorized := router.Group("/admin", gin.BasicAuth(gin.Accounts{
 		"foo":    "bar",
 		"austin": "1234",
 		"lena":   "hello2",
@@ -36,6 +36,6 @@ func main() {
 	})
 
 	// Listen and serve on 0.0.0.0:8080
-	r.Run(":8080")
+	router.Run(":8080")
 }
 ```