Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial work-in-progress on editing pass #13

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tungstonminer
Copy link

DO NOT MERGE

A while back, I promised to help out with editing the wiki. I'm afraid it's taken me a while to make good on that, but this represents a first effort in that direction. Mostly this is small spelling, punctuation, and clarity edits. There were a few articles, though, which I thought could use some deeper editing (e.g., Hatches), so I went a bit deeper on those.

I've also changed the formatting of the code itself in a few articles to make it a bit easier to manage in a programming-oriented text editor. I'm happy to decist or continue with that sort of re-formatting as you all would prefer. It also looks like there was a bunch of trailing whitespace in some of the files which my editor automatically removed. Sorry for the extra noise in the diff!

Please let me know if this sort of contribution is helpful, and I'll carry on with this pull request. I figured it would be best for me to just do a small piece and get some feedback before getting too far along!

@@ -1,18 +1,19 @@
<?php
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes here are just to correct a few names to match the in-game names, and to alphabetize things which were out of order.

<p>Power generated is stored to the Output Plugs built into the structure.</p>
<p><font color=#CC0000><b>Warning:</b></font> Entities, items, and blocks that happen to be above the Microwave Reciever while in operation will be incinerated!!!</p>';


Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an example of the code-formatting changes I propose. This keeps each paragraph clearly distinct from the next, and limits line length to 120 characters to make life a bit easier both in an editor, and on GitHub.

$description1 = '<p>The Docking Pad can be placed on a space station to specify a landing location for rockets on space stations.</p>
<p>If all the Docking Pads on a space station are full or reserved, then an incoming rocket will land at the origin.</p>
<p>Infrastructure such as <a href="Hatches.php#rocket">Rocket loaders/unloaders</a>, fuel loaders, and <a href="RocketMonitoringStation.php">Rocket Monitoring Stations</a> can be connected to it using the <a href="../items/linker.php">linker</a>.</p>
<p>Infrastructure such as <a href="Hatches.php">Rocket Loaders/Unloaders</a>, fuel loaders, and <a href="RocketMonitoringStation.php">Rocket Monitoring Stations</a> can be connected to it using the <a href="../items/linker.php">linker</a>.</p>
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just noticed this is wrong, too... there's a separate page for loader/unloaders now, which is where this really should link to.

conduit (e.g., a Fluxduct from Thermal Dynamics). Power Ouput Plugs are included in machines which
generate power (like the Microwave Receiver previously mentioned) so that the power it generates may be
transmitted to other machines or a power grid.</p>
<p id="rockets">There are also a set of hatch-like blocks which are specialized for loading and unloading
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left this here because there are at least a few other pages which refer people to Hatches instead of Loaders/Unloaders.

@tungstonminer tungstonminer marked this pull request as draft November 2, 2020 16:38
@tungstonminer
Copy link
Author

@dmodoomsirius, I've been holding off on continuing here until I get a 👍 / 👎 on this pull request... Do you think you might have time to give it a quick once-over this weekend?

@dmodoomsirius dmodoomsirius self-assigned this Nov 9, 2020
@dmodoomsirius dmodoomsirius self-requested a review November 9, 2020 21:02
@dmodoomsirius
Copy link
Collaborator

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants