You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-11Lines changed: 26 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,6 +78,8 @@ Using the above example, you can see that a German language version of `index.md
78
78
79
79
Please note that if you need to add a new language to the list, you will also need to edit `/config/_default/languages.toml` (pay attention to indentation!). 2 letter ISO codes are used, for a list you can [refer to this document](https://www.iban.com/country-codes). Use the lower-case versions otherwise our documentation engine freaks out.
80
80
81
+
Lastly, create a copy of `/i18n/en.yaml` and name it with the newly added country code. This file contains the translations used by shortcodes throughout the site.
82
+
81
83
When you add content in other languages, note that you do not need to update the links to point to the language-specific version of the documentation - the documentation engine will sort this out for you.
82
84
83
85
### Convenience Functions
@@ -126,24 +128,33 @@ This is an example multi-line alert.
126
128
{{< /alert >}}
127
129
```
128
130
131
+
#### Carousel
132
+
A carousel is a slideshow for cycling through a series of images. List the images you would like to include inside the carousel element. Each picture will automatically be sequentially numbered. To add a caption to an image, follow the image path with a pipe (`|`) and then the caption text:
133
+
```hugo
134
+
{{< carousel >}}
135
+
images/image-1.jpg
136
+
images/image-2.jpg | Caption for image 2
137
+
images/image-3.jpg
138
+
images/image-4.jpg | Caption for image 4
139
+
{{< /carousel >}}
140
+
```
141
+
129
142
#### Details
130
-
Shortcode:
143
+
This shortcode is simply a wrapper for the HTML [details element](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/details). Specify the summary text and optionally choose whether to have the element open by default instead of closed.
144
+
131
145
```
132
-
{{< details <summary> [state] >}}
133
-
<content>
146
+
{{< details "Summary text" >}}
147
+
Content goes here. This will be hidden until the user clicks to expand.
148
+
{{< /details >}}
149
+
150
+
{{< details "Summary text" "open" >}}
151
+
This content will be visible by default because state is set to "open".
134
152
{{< /details >}}
135
153
```
136
154
137
155
#### Document Status
138
156
139
-
This is a variation of the Alert shortcode however it has different statuses depending on what's required.
140
-
141
-
Shortcode:
142
-
```
143
-
{{< docstatus status="STATUS" >}}
144
-
```
145
-
146
-
The following statuses are supported:
157
+
This is a variation of the Alert shortcode with certain predefined statuses. The following statuses are supported:
147
158
148
159
* (blank) - Defaults to "not yet written"
149
160
*`workinprogress` - Documentation is in progress and subject to change.
@@ -154,6 +165,10 @@ The following statuses are supported:
154
165
*`obsolete` - States that no further development will occur on this component, but it is retained for compatibility reasons.
155
166
*`untranslated` - Documentation has not been translated into your native language yet. This will gradually disappear as more efforts are put into translation for various locales.
156
167
168
+
```
169
+
{{< docstatus status="STATUS" >}}
170
+
```
171
+
157
172
#### Simple image
158
173
159
174
This will allow you to create quick, simple images that can be inserted into the body of documentation, with additional CSS classes.
Copy file name to clipboardExpand all lines: content/docs/feature-guides/canals/index.md
+33-32Lines changed: 33 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,64 +9,65 @@ images: []
9
9
url: "docs/feature-guides/canals"
10
10
---
11
11
12
+
{{< docstatus status="legacy" >}}
13
+
12
14
## Overview
13
15
14
16
The CAN-AM is designed to work with either the **CAL SG Canals** by callagrafx (recommended) or the original **SG Canals** by SimGoober.
15
-
Both of these are available in the [SC4D LEX Legacy - BSC Canals Collection](https://www.sc4evermore.com/index.php/downloads/download/14-park/277-sc4d-lex-legacy-bsc-canals-collection). This package also includes additional passenger and freight stations, as NAM CAN-AM only includes a single passenger station.
17
+
Both of these are available in the [SC4D LEX Legacy - BSC Canals Collection](https://www.sc4evermore.com/index.php/downloads/download/14-park/277-sc4d-lex-legacy-bsc-canals-collection). This package also includes additional passenger and freight stations. Additional ferry skins may be found in the [SC4D LEX Legacy - BSC VDK Mods Ferries](https://www.sc4evermore.com/index.php/downloads/download/41-automata-mods/298-sc4d-lex-legacy-vdk-mods-ferries) package, among others.
16
18
17
19
The CAN-AM is available under **2 Network Features** → **Water Transport** → **Canal Addon Mod**. It is installed by default.
18
20
19
-
## Building CAN-AM Canals
20
-
21
-
The canal pieces are located under the Misc. Transit menu.
21
+
Note that CAN-AM is an older feature that has not seen much new development in the past decade. As such, it is reliant on a limited array of semi-deprecated/legacy features, especially in terms of crosslinks with newer and more modern NAM features.
To build a functional canal with CAN-AM, start by building the outer walls of the canal with your canal set (in this case, the CAL SG Canals). In between the walls, place the CAN-AM pieces, which provide the actual transportation functionality. CAN-AM canals must be _at least 3 tiles wide:_ 2 tiles for the walls on each side, and at least 1 tile for the CAN-AM pieces.
25
+
To build a functional canal with CAN-AM, start by building the outer walls of the canal with your chosen canal set (in this case, the CAL SG Canals). Use the CAN-AM pieces, located in the Misc. Transit menu, in between the outer walls. These pieces provide the actual transportation functionality. Note that CAN-AM canals must be at least 3 tiles wide: 2 tiles for the walls on each side, and at least 1 tile for the CAN-AM pieces.
images/can-am-building-2.jpg | Place the outer walls of the canal
30
+
images/can-am-menu-button.jpg | Use the functional canal pieces
31
+
images/can-am-building-3.jpg | Place functional canal pieces in between the walls
32
+
images/can-am-building-4.jpg | The finished canal must be minimum 3 tiles wide
33
+
{{< /carousel >}}
33
34
34
-
Crossings with CAN-AM are currently puzzle piece-based. There are two versions of each crossing piece for the supported network crossings--one for the wall, and one for the open water. The open water tiles allow for canal traffic to pass underneath.
35
+
### Crossings
35
36
36
-
The crossing can be assembled as follows:
37
+
Crossings with CAN-AM are currently puzzle piece-based. There are two versions of each crossing piece for the supported network crossings: one for the wall, and one for the center canal traffic, allowing canal traffic to pass underneath. The crossing can be assembled as follows:
images/can-am-building-5.jpg | Place the center piece allowing traffic
41
+
images/can-am-building-6.jpg | Place the edge pieces
41
42
images/can-am-building-7.jpg
42
-
{{< /gallery >}}
43
+
{{< /carousel >}}
43
44
44
-
Neighbor Connections with CAN-AM are possible as well. Build a standard Road-based Neighbor Connection, and plop the CAN-AM pieces over top of the Road.
Neighbor Connections with CAN-AM are possible as well. Start by building a standard Road-based Neighbor Connection, and then plop the CAN-AM pieces over top of the Road.
51
48
52
-
Note that CAN-AM is an older feature that has not seen much new development in the past decade. As such, it is reliant on a limited array of semi-deprecated/legacy features, especially in terms of crosslinks with newer/more modern NAM features.
49
+
{{< carousel >}}
50
+
images/can-am-nc-1.jpg | Start with a road neighbor connection
51
+
images/can-am-nc-2.jpg | Plop canal transit pieces over the road
52
+
images/can-am-nc-3.jpg | Plop canal transit pieces over the road
53
+
{{< /carousel >}}
53
54
54
-
## CAN-AM Stations
55
55
56
-
The CAN-AM canals function as a mass transit network and is technically based on the Bus vehicle type, meaning they need stations to properly function. The CAS 1x1 Ferry Terminal (included in the mod) is one option. Place it aligned with a canal wall, with the arrow pointing toward the water in the canal. The stations require Power in order to function.
The CAN-AM canals function as a mass transit network based on the Bus vehicle type, meaning they need stations to properly function. The NAM includes one passenger ferry terminal - additional passenger and freight stations are available in the BSC Canals Collection linked above. Place the station aligned with a canal wall, with the arrow pointing toward the water in the canal. The stations require power in order to function.
59
+
60
+
{{< carousel >}}
59
61
images/can-am-building-8.jpg
60
62
images/can-am-building-9.jpg
61
63
images/can-am-building-10.jpg
62
-
{{< /gallery >}}
63
-
64
-
Note that in order for canal boat automata to appear on the canals, one of the "magic pieces" must be placed as part of the build process, preferrably in the open water next to the station. These include the + and T-intersections, as well as the 90° L-bend. (Thanks to <strong>CorinaMarie</strong> for this discovery!)
64
+
images/can-am-building-10a.jpg | Place one of the "magic pieces"
Note that in order for canal boat automata to appear on the canals, one of the "magic pieces" must be placed as part of the build process, preferably in the open water next to the station. These include the + and T-intersections, as well as the 90° L-bend. (Thanks to <strong>CorinaMarie</strong> for this discovery!)
If everything is done properly (at least two stations of the same type are needed for full functionality), traffic should begin to use the canal.
71
+
If everything is done properly, traffic should begin to use the canal. Like any other mass transit network, at least two stations of the same type are needed for full functionality.
<td>Questa particolare caratteristica può essere costruita, ma non in tutti i casi. Verranno forniti dettagli su ciò che è/non è possibile. Il supporto parziale può essere dovuto a ragioni di progettazione intenzionali (come il realismo o la non fattibilità generale), o semplicemente perché la caratteristica non è stata completamente sviluppata.</td>
<td>Questa particolare caratteristica può essere costruita, ma solo in circostanze estremamente limitate. I casi possibili possono essere elencati, nella misura in cui è possibile. L'uso è a proprio rischio e pericolo.</td>
30
-
</tr>
31
-
<tr>
32
-
<td data-compat="no"> Nessun supporto </td>
33
-
<td>Questa particolare caratteristica non può essere costruita. Questa restrizione può essere dovuta a ragioni di progettazione intenzionali (come il realismo, la non fattibilità generale o le limitazioni del gioco) o semplicemente perché non è ancora stata sviluppata.</td>
34
-
</tr>
35
-
</table>
36
-
37
-
### Additional Notes
14
+
## Chiave
38
15
39
-
**OxO**: OxO sta per "ortogonale x ortogonale" e si riferisce a una situazione in cui entrambe le reti sono ortogonali (in linea retta) lungo la griglia di gioco, intersecandosi perpendicolarmente (con angoli di 90° in tutti gli angoli).
16
+
{{< compatibility-key >}}
40
17
41
-
**OxD**: OxD sta per "ortogonale x diagonale" e si riferisce a una situazione in cui la rete data è ortogonale (in linea retta) lungo la griglia di gioco e la rete trasversale è diagonale (con un angolo di 45°).
42
-
43
-
**DxO**: DxO sta per "diagonale x ortogonale" e si riferisce a una situazione in cui la rete di base è diagonale (con un angolo di 45°) e la rete trasversale è ortogonale (in linea retta) lungo la griglia di gioco.
44
-
45
-
**DxD**: DxD sta per "diagonale x diagonale" e si riferisce a una situazione in cui entrambe le reti sono diagonali (con un angolo di 45°) lungo la griglia di gioco e si intersecano perpendicolarmente (con angoli di 90° in tutti gli angoli).
0 commit comments