Adding to the KS documentation and cleaning file extensions

StardustGogeta · Apr 20, 2016 · 1399cb5 · 1399cb5
1 parent d40988c
commit 1399cb5
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 13 deletions.
diff --git a/CSS/ksdocs.css b/CSS/ksdocs.css
@@ -101,7 +101,7 @@ a
 	background-color: #ffff99;
 	color: black;
 	padding: 1em;
-	font-size: 1em;
+	font-size: 1.5vw;
 }
 
 .exa

diff --git a/index.html b/index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 	<head>
-		<title>StardustGogeta</title>
+		<title>StardustGogeta - Home Page</title>
 		<link rel="stylesheet" type="text/css" href="Bootstrap/bootstrap.min.css">
 		<link rel="stylesheet" type="text/css" href="CSS/main.css">
 		<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.0/jquery.min.js"></script>

diff --git a/ksdocs/embed.html b/ksdocs/embed.html
@@ -2,7 +2,7 @@
 <html>
 	<head>
 		<title>Embedding Python</title>
-		<a href="index.html"><div id="return">Return to Categories</div></a>
+		<a href="index"><div id="return">Return to Categories</div></a>
 		<link rel="stylesheet" type="text/css" href="../CSS/ksdocs.css">
 	</head>
 	<body>
@@ -11,5 +11,10 @@ <h3>&lt;python&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;[pythonCode]<br>&lt;/python&gt;</h
 		<div class='exp'>Between tags reminiscent of HTML, Python code can be directly inserted into a KerbalSpace document.
 		This will only work when the tags appear on their own lines, and does not work for
 		partial lines of code.</div>
+		<h3>--[pythonCode]</h3>
+		<div class='exp'>Immediately after two dashes in a row appear at the start of a line,
+		the line is transcribed directly into the output Python file. This can be used like above,
+		but is intended for single lines which are currently missing counterparts within KerbalSpace.
+		Do not place whitespace after the dashes if it is not meant to be included in the transciption.</div>
 	</body>
 </html>
diff --git a/ksdocs/func.html b/ksdocs/func.html
@@ -2,7 +2,7 @@
 <html>
 	<head>
 		<title>Functions</title>
-		<a href="index.html"><div id="return">Return to Categories</div></a>
+		<a href="index"><div id="return">Return to Categories</div></a>
 		<link rel="stylesheet" type="text/css" href="../CSS/ksdocs.css">
 	</head>
 	<body>

diff --git a/ksdocs/import.html b/ksdocs/import.html
@@ -2,7 +2,7 @@
 <html>
 	<head>
 		<title>Importing Files</title>
-		<a href="index.html"><div id="return">Return to Categories</div></a>
+		<a href="index"><div id="return">Return to Categories</div></a>
 		<link rel="stylesheet" type="text/css" href="../CSS/ksdocs.css">
 	</head>
 	<body>

diff --git a/ksdocs/index.html b/ksdocs/index.html
@@ -2,7 +2,7 @@
 <html>
 	<head>
 		<title>KerbalSpace Documentation</title>
-		<a href="../../index.html"><div id="return">Return to Home Page</div></a>
+		<a href="../index"><div id="return">Return to Home Page</div></a>
 		<link rel="stylesheet" type="text/css" href="../CSS/ksdocs.css">
 	</head>
 	<body>
@@ -12,13 +12,17 @@ <h1>KerbalSpace Documentation</h1>
 		any way. The language is free to use and examples are available on GitHub. The official
 		KS to Python compiler will also be maintained on GitHub under my account.<br><br>
 		Within this documentation, all parameters will appear as <span class='exa'>mixedCase</span>, and all
-		optional parameters will be enclosed in <span class='exa'>[square brackets]</span>.</div>
+		optional parameters will be enclosed in <span class='exa'>[square brackets]</span>.<br>
+		If you want more advanced documentation or need to clarify anything, ask by messaging me on
+		<a href='http://steamcommunity.com/id/StardustGogeta'>Steam</a> or on
+		<a href='https://plus.google.com/b/106587151299143925980/106587151299143925980'>Google+</a>.</div>
 		<h2>Categories</h2>
 		<ol>
-			<a href="io.html"><li>Input and Output</li></a>
-			<a href="func.html"><li>Functions</li></a>
-			<a href="import.html"><li>Importing Files</li></a>
-			<a href="embed.html"><li>Embedding Python</li></a>
+			<a href="io"><li>Input and Output</li></a>
+			<a href="loops"><li>Loops and Conditionals</li></a>
+			<a href="func"><li>Functions</li></a>
+			<a href="import"><li>Importing Files</li></a>
+			<a href="embed"><li>Embedding Python</li></a>
 		</ol>
 	</body>
 </html>
diff --git a/ksdocs/io.html b/ksdocs/io.html
@@ -2,15 +2,15 @@
 <html>
 	<head>
 		<title>Input and Output</title>
-		<a href="index.html"><div id="return">Return to Categories</div></a>
+		<a href="index"><div id="return">Return to Categories</div></a>
 		<link rel="stylesheet" type="text/css" href="../CSS/ksdocs.css">
 	</head>
 	<body>
 		<h1>KerbalSpace - Input and Output</h1>
 		<h3>> [text]</h3>
 		<div class='exp'>This is the printing function, converting the
 		contents of the line into an argument for <span class='exa'>print()</span> in Python.</div>
-		<h3>< (storageVariable) [, promptString]</h3>
+		<h3>< storageVariable [, promptString]</h3>
 		<div class='exp'>This is the reading function, representing <span class='exa'>storageVariable = input([promptString])</span> in Python.</div>
 	</body>
 </html>
diff --git a/ksdocs/loops.html b/ksdocs/loops.html
@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<title>Loops and Conditionals</title>
+		<a href="index"><div id="return">Return to Categories</div></a>
+		<link rel="stylesheet" type="text/css" href="../CSS/ksdocs.css">
+	</head>
+	<body>
+		<h1>KerbalSpace - Loops and Conditionals</h1>
+		<h3>? condition [: ifTrue] [: ifFalse]<br>
+			&nbsp;&nbsp;&nbsp;&nbsp;[ifTrue]</h3>
+		<div class='exp'>Similar to a ternary statement in Python, an entire if / else structure
+		can be placed on one line. Additionally, this does not require colons when only the condition
+		is included, and instead detects only from the indents on the next lines.</div>
+	</body>
+</html>