fez5587/Superalgos
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'upstream/in-app-documentation' into in-app-documentation

Browse Source
This commit is contained in:
Luis Fernando Molina committed 2021-01-11 20:57:31 +01:00
2 parents d793e63e52 07d8931d14
commit aa28c2e807
11 files changed
+360 -19
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Client/WebServer/css/docs.css
+29 -19
View File
@@ -919,15 +919,26 @@ color: #31708f;
}
.docs-hidden-anchor {
color: #b90d6c;
background-color: #ee6db4;
border-color: #830452;
padding: 15px;
border: 1px solid transparent;
border-radius: 4px;
margin: 20px 0;
width: 100%;
}
border-top: 1px solid #eee;
padding: 0px;
margin: -15px 0px -30px 0;
width: 100%;
text-align: right;
color: transparent;
font-size: 75%;
}
.docs-hidden-anchor::after{
content:' \2693';
color: transparent;
font-size: 150%;
}
.docs-hidden-anchor:hover::after{
content:' \2693';
color: #365558;
font-size: 150%;
}
.docs-hidden-block {
border-top: 1px solid #eee;
@@ -937,20 +948,19 @@ width: 100%;
text-align: right;
color: transparent;
font-size: 75%;
}
.docs-hidden-block::after{
content:' \25BD';
color: #e0e0e0;
font-size: 150%;
}
content:' \25BD';
color: #e0e0e0;
font-size: 150%;
}
.docs-hidden-block:hover::after{
content:' \25BC';
color: #365558;
font-size: 150%;
}
.docs-hidden-block:hover::after{
content:' \25BC';
color: #365558;
font-size: 150%;
}
.docs-hidden-include {
border-top: 1px solid #eee;
Projects/Superalgos/GIFs/Docs/indicators/masters-bots-layers-04-bollinger-bands.gif
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 MiB

Projects/Superalgos/GIFs/Docs/indicators/masters-bots-layers-05-percentage-bandwidth.gif
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.0 MiB

Projects/Superalgos/GIFs/Docs/indicators/masters-bots-layers-06-percentage-bandwidth-2.gif
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.3 MiB

Projects/Superalgos/GIFs/Docs/indicators/masters-bots-layers-07-bollinger-channels.gif
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.0 MiB

Projects/Superalgos/GIFs/Docs/indicators/masters-bots-layers-08-bollinger-subchannels.gif
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.7 MiB

Projects/Superalgos/Schemas/Docs-Topics/bollinger-bands-bb-b.json
+141
View File
@@ -0,0 +1,141 @@
{
"topic": "Masters",
"pageNumber": "1",
"type": "Bollinger Bands (BB - %B)",
"definition": {
"text": "The indicator produces the Bollinger Bands (BB) and Percentage Bandwith (%B), both in standard settings.",
"updated": 1610387450406
},
"paragraphs": [
{
"style": "Title",
"text": "On the Charts",
"updated": 1610384466638
},
{
"style": "Subtitle",
"text": "Bollinger Bands"
},
{
"style": "Text",
"text": "This is the traditional Bollinger Bands indicator. Bollinger Bands have a moving average, in our case calculated with the last 20 periods (the line in the middle of the bands). We are plotting the moving average with one color when it is going up, and with a different color when it’s going down. The upper band is at 2 Standard Deviations from the moving average, pretty much like the lower band, also at 2 Standard Deviations. These are the most widely used Bollinger Bands settings."
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/indicators/masters-bots-layers-04-bollinger-bands.gif",
"updated": 1610385365026
},
{
"style": "Subtitle",
"text": "Percentage Bandwidth"
},
{
"style": "Text",
"text": "This is a well-known indicator that derives from the Bollinger Bands. In a nutshell, it tells you how close the price is either to the upper band or the lower band at any point in time. When the price is in the middle of the bands (it is calculated with the close value of each candle), then %B is in the middle of its chart, at value 50. When the price touches the upper band, then %B is at 100, and finally when the price is at the lower band, then %B is at 0."
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/indicators/masters-bots-layers-05-percentage-bandwidth.gif",
"updated": 1610385389070
},
{
"style": "Text",
"text": "The chart features lines at %B values 30 and 70 since those are the most common values for traders to forecast when a reversal may happen. In our chart, %B is the one represented at #1. We’ve found useful to add a moving average to smooth volatility a bit and to be able to ask—at any time—if it is going up or down. The moving average calculated with the last 5 %B values is plotted as line #2. Finally, we’ve also added a property called Bandwidth, which represents the separation of the upper band from the lower band. It is a measure of volatility and is plotted at #3."
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/indicators/masters-bots-layers-06-percentage-bandwidth-2.gif",
"updated": 1610385427575
},
{
"style": "Title",
"text": "Products & Properties"
},
{
"style": "Subtitle",
"text": "Bollinger Bands"
},
{
"style": "Text",
"text": "The product bollingerBand features four different properties that you may use."
},
{
"style": "Table",
"text": "| Product Name | Product Variable | Property Variables |\n| Bollinger Bands | bollingerBand | movingAverage, standardDeviation, deviation, direction |",
"updated": 1610384742825
},
{
"style": "List",
"text": "bollingerBand.movingAverage: The value of the current moving average (20 periods)."
},
{
"style": "List",
"text": "bollingerBand.standardDeviation: The value of current the standard deviation."
},
{
"style": "List",
"text": "bollingerBand.deviation: bollingerBand.standardDeviation * 2"
},
{
"style": "List",
"text": "bollingerBand.direction:"
},
{
"style": "Text",
"text": "\"Down\": ",
"updated": 1610384819019
},
{
"style": "Javascript",
"text": "bollingerBand.previous.movingAverage > bollingerBand.movingAverage"
},
{
"style": "Text",
"text": "\"Up\":",
"updated": 1610384830529
},
{
"style": "Javascript",
"text": "bollingerBand.previous.movingAverage < bollingerBand.movingAverage"
},
{
"style": "Text",
"text": "\"Side\": ",
"updated": 1610384838620
},
{
"style": "Javascript",
"text": "bollingerBand.previous.movingAverage = bollingerBand.movingAverage",
"updated": 1610384852450
},
{
"style": "Subtitle",
"text": "Percentage Bandwidth"
},
{
"style": "Text",
"text": "The product percentageBandwidth features four different properties that you may use."
},
{
"style": "Table",
"text": "| Product Name | Product Variable | Property Variables |\n| Percentage Bandwidth | percentageBandwidth | value, movingAverage, bandwidth, direction |",
"updated": 1610384984134
},
{
"style": "List",
"text": "percentageBandwidth.value: A numeric value between 0 and 100; the current value of the percentage bandwidth."
},
{
"style": "List",
"text": "percentageBandwidth.movingAverage: A numeric value between 0 and 100; the current value of the percentage bandwidth moving average."
},
{
"style": "List",
"text": "percentageBandwidth.bandwidth: A numeric value between 0 and 100; the current bandwidth."
},
{
"style": "Text",
"text": ""
}
]
}
Projects/Superalgos/Schemas/Docs-Topics/bollinger-channels.json
+96
View File
@@ -0,0 +1,96 @@
{
"topic": "Masters",
"pageNumber": "2",
"type": "Bollinger Channels",
"definition": {
"text": "The indicator produces the Bollinger Channels and Bollinger Subchannels products.",
"updated": 1610385654126
},
"paragraphs": [
{
"style": "Title",
"text": "On the Charts",
"updated": 1610385639559
},
{
"style": "Subtitle",
"text": "Bollinger Channels"
},
{
"style": "Text",
"text": "This is a non-standard indicator derived from the Bollinger Bands. These types of channels are calculated using the Bollinger Bands moving average. Essentially an upward channel begins when the moving average changes direction from going down to going up, and the channel finishes when it turns from going up to down. A downward channel starts when the Bollinger Band moving average turns from going up to down, and it finishes when it starts going up again. Upward channels are plotted in green, while downward channels in red. Additional information can be found at the indicator’s panel, like the number of periods contained at the channel."
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/indicators/masters-bots-layers-07-bollinger-channels.gif",
"updated": 1610385920623
},
{
"style": "Anchor",
"text": "Bollinger Sub-Channels"
},
{
"style": "Subtitle",
"text": "Bollinger Sub-Channels"
},
{
"style": "Text",
"text": "If we consider that one Bollinger Channel can have sub-channels in the same direction (up or down) but different slopes, then we get to the concept of Bollinger Sub-Channels. The most important property of a sub-channel is its slope. The possible values are Side, Gentle, Medium, High and Extreme. With this information, a trading bot could easily ask if it is in a sub-channel with a certain slope and for how many periods. The slope or inclination of the moving average may be an indication of momentum."
},
{
"style": "Gif",
"text": "GIFs/Superalgos/Docs/indicators/masters-bots-layers-08-bollinger-subchannels.gif",
"updated": 1610385965423
},
{
"style": "Title",
"text": "Products & Properties"
},
{
"style": "Subtitle",
"text": "Bollinger Channels"
},
{
"style": "Text",
"text": "The product bollingerChannel features two different properties that you may use."
},
{
"style": "Table",
"text": "| Product Name | Product Variable\t| Property Variables |\n| Bollinger Channels | bollingerChannel | direction, period |",
"updated": 1610385740520
},
{
"style": "List",
"text": "bollingerChannel.direction: Possible values are \"Down\", \"Up\", and \"Side\"."
},
{
"style": "List",
"text": "bollingerChannel.period: The number of periods the channel spans at the moment the variable is being read. For instance, if a channel spans 10 candles and the variable is checked on the fourth candle, then bollingerChannel.period = 4. Put in other words, it is the current span of the channel."
},
{
"style": "Subtitle",
"text": "Bollinger SubChannels"
},
{
"style": "Text",
"text": "The product bollingerSubChannel features three different properties that you may use."
},
{
"style": "Table",
"text": "| Product Name | Product Variable | Property Variables |\n| Bollinger SubChannels | bollingerSubChannel | direction, period, slope |",
"updated": 1610385815244
},
{
"style": "List",
"text": "bollingerSubChannel.direction: Possible values are \"Down\", \"Up\", and \"Side\"."
},
{
"style": "List",
"text": "bollingerSubChannel.period: The number of periods the subchannel spans at the moment the variable is being read. For instance, if a subchannel spans 10 candles and the variable is checked on the fourth candle, then bollingerChannel.period = 4. Put in other words, it is the current span of the subchannel."
},
{
"style": "List",
"text": "bollingerSubChannel.slope: Indicates how steep the slope of the subchannel is. Possible values are \"Side\", \"Gentle\", \"Medium\", \"Steep\", \"Extreme\" (in order from lowest to highest)."
}
]
}
Projects/Superalgos/Schemas/Docs-Topics/docs-anchor-style.json
+24
View File
@@ -0,0 +1,24 @@
{
"topic": "Docs Paragraph Styles",
"pageNumber": "21",
"type": "Docs Anchor Style",
"definition": {
"text": "Amchor paragraphs are used together with the Docs Goto Command. When you want to generate a Docs Link to an specific part of a Docs Page, you first need to create an Anchor paragraph in order to be able to create the link to that part of the page.",
"updated": 1609258745310
},
"paragraphs": [
{
"style": "Text",
"text": "To correctly define an Anchor Paragraph, you need to follow the following syntax:",
"updated": 1610387812416
},
{
"style": "Javascript",
"text": "Anchor Name"
},
{
"style": "List",
"text": "Anchor Name: This refers to any name that you would like to give to the newly created Anchor. The name must be unique within the page."
}
]
}
Projects/Superalgos/Schemas/Docs-Tutorials/tutorial-step-reinforce-the-learning.json
+31
View File
@@ -0,0 +1,31 @@
{
"tutorial": "3. Testing a Trading Idea - The Trigger Stage",
"pageNumber": 14,
"type": "Tutorial Step - Reinforce The Learning!",
"definition": {
"icon": {
"project": "Superalgos",
"name": "learning-bot"
},
"text": "Let's do a quick recap on the matter of the syntax! I'll push this until you learn it!"
},
"paragraphs": [
{
"style": "List",
"text": "FIRST: The time frame! (i.e.: chart.at24hs)"
},
{
"style": "List",
"text": "SECOND: Each segment of the instruction is separated by dots! (i.e.: like.this)"
},
{
"style": "List",
"text": "THIRD: Product name and property name are determined by the indicator you are using. No need to memorize them, as you may copy and paste them from the docs when you need them!"
},
{
"style": "List",
"text": "FOURTH: Compound words in the product and property name are written in camel case, that is, altogether, with the first word in lowercase and the rest of the words capitalized! (forExampleLikeThis)",
"updated": 1610384140775
}
]
}
Projects/Superalgos/Schemas/Docs-Tutorials/tutorial-step-the-pipeline.json
+39
View File
@@ -0,0 +1,39 @@
{
"tutorial": "3. Testing a Trading Idea - The Trigger Stage",
"pageNumber": 2,
"type": "Tutorial Step - The Pipeline",
"definition": {
"icon": {
"project": "Superalgos",
"name": "dataset-definition"
},
"text": "We will cover several topics! Let's make a quick list to use as a guide along the way!"
},
"paragraphs": [
{
"style": "List",
"text": "The Trigger Stage with it's three events (Trigger On Event, Trigger Off Event, and Take Position Event).",
"updated": 1610382946451
},
{
"style": "List",
"text": "Basic definitions including what is a Situation, a Condition, and a Formula."
},
{
"style": "List",
"text": "Syntax, or how to write conditions and formulas."
},
{
"style": "List",
"text": "Indicator properties and how to use them."
},
{
"style": "List",
"text": "Open, Manage, and Close Stages basics."
},
{
"style": "Success",
"text": "Have you read about these topics? No worries... you will!"
}
]
}