Documentation

All discussion on project related documentation including source docs, manuals, and tutorials go here.
DavidD
Posts: 17
Joined: 25 Jun 2016, 22:33

Re: Documentation

Post by DavidD » 10 Sep 2016, 23:23

Figured I'd post an update as well.

My life is now back on track and on a schedule since school has started, and I've been able to commit more frequently and plan on keeping this up now. Currently working my way through the mwworld folder, though of course I haven't gotten as far as I would have liked...

User avatar
raevol
Posts: 2455
Joined: 07 Aug 2011, 01:12
Location: Caldera

Re: Documentation

Post by raevol » 11 Sep 2016, 03:45

Ravenwing wrote:Have we decided to use American or British English?
'MURICA!

Just kidding. I should probably stop wrecking our release announcements with American English.

User avatar
psi29a
Posts: 3432
Joined: 29 Sep 2011, 10:13
Github profile: https://github.com/psi29a/
Contact:

Re: Documentation

Post by psi29a » 11 Sep 2016, 07:26

Pick a style and go with it. ;)

Update: It has to be readable/understandable to the majority of English speakers.

Update 2: If people want to write their own documentation in another language, I'll try to figure out multi-language support.

User avatar
Ravenwing
Posts: 130
Joined: 02 Jan 2016, 02:51

Re: Documentation

Post by Ravenwing » 11 Sep 2016, 20:18

psi29a wrote:Pick a style and go with it.
*Laughs maniacally*
psi29a wrote:Update: It has to be readable/understandable to the majority of English speakers.
Kill joy. But seriously, yes, I was planning on being conversationally simple so it's easy to understand and translate, but not antiseptic. And I'll probably go through a few different styles before I settle on one and write up a brief style guide. I'm guessing no one will feel like I'm stepping on toes if I go back through and edit some of the earlier stuff to match character and tone?
raevol wrote:'MURICA!
Ugh, I just vomited a little. Lol, I was actually considering British English because I know many developers and fans are European. I assumed everyone in Europe learned British English, but if you learned American English, DavidD, then maybe we have more American English users. I know we have a lot of Germans. What do they usually teach in Germany? I'm sure this is making a much larger deal out of it than it needs to be, but I love uniformity and consistency. Would a poll perhaps be helpful?
DavidD wrote: Mostly just Git related things. Knowing how to fork a repository, committing, pushing, merging, and pull requests will get you far. Since the documentation is mostly unwritten, you have pretty free hands. The source documentation is located inside the docs/source folder. The "openmw" folder is currently used for the source code, and the "openmw-cs" is for the cs manual.

If you need any help or have any questions, feel free to ask here!

What are you considering writing about?
Thanks! I will probably have many, sooooo...

I was planning on starting with the User Documentation from the Wiki so all I have to focus on is syntax. Once I get that down I think I'll move on to OpenMW-CS. If there's any kind of grunt work type stuff for the source documentation, I'm willing to help with that as long as it doesn't require a deep understanding of the code. I have an extremely basic understanding of C++, so I'm not entirely useless, but I don't want to misunderstand and mislead people.

User avatar
raevol
Posts: 2455
Joined: 07 Aug 2011, 01:12
Location: Caldera

Re: Documentation

Post by raevol » 11 Sep 2016, 22:36

Ravenwing wrote:Ugh, I just vomited a little. Lol, I was actually considering British English because I know many developers and fans are European.
I honestly did too, but there's sacrifices you have to make in the name of comedy. :D

I don't think we need a poll, people should just do what they are comfortable with, favoring British English if they can. We shouldn't discourage contributions just because of opinions on spelling.

User avatar
AnyOldName3
Posts: 541
Joined: 26 Nov 2015, 03:25

Re: Documentation

Post by AnyOldName3 » 12 Sep 2016, 01:14

raevol wrote:
Ravenwing wrote:Ugh, I just vomited a little. Lol, I was actually considering British English because I know many developers and fans are European.
I honestly did too, but there's sacrifices you have to make in the name of comedy. :D

I don't think we need a poll, people should just do what they are comfortable with, favoring British English if they can. We shouldn't discourage contributions just because of opinions on spelling.
The superiority of British spellings is not an opinion. It is a fact.

User avatar
lysol
Posts: 701
Joined: 26 Mar 2013, 01:48
Location: Sweden

Re: Documentation

Post by lysol » 12 Sep 2016, 07:19

Swedes learn english as British English in school, then relearn English as American English from movies and internet. That's it kind of. The Brits need to start making more movies if they want us to speak like them.
Normal mapped texture replacers, exclusive for OpenMW:
My Nexus page

DavidD
Posts: 17
Joined: 25 Jun 2016, 22:33

Re: Documentation

Post by DavidD » 17 Sep 2016, 20:16

I've been looking at CellStore for a while now, but I don't understand why mMovedHere and mMovedToAnotherCell are needed. Could someone with more knowledge about this explain why they are needed? Why not just add them directly into e.g. mArmors and make the item owned by the cell that the object is moved to?

MWWorld should be mostly implemented at this point, right? So I should be able to rely on major pieces of code remaining for the final release unless nothing else is stated? In that case I can start writing more in-depth instead of just scraping the surface

User avatar
Zini
Posts: 5132
Joined: 06 Aug 2011, 15:16

Re: Documentation

Post by Zini » 18 Sep 2016, 10:49

Because that is not how Morrowind works. Instances are kept in their original cells. We can't change that without breaking a whole lot of stuff (mods, the esp/esm format and so on).

DavidD
Posts: 17
Joined: 25 Jun 2016, 22:33

Re: Documentation

Post by DavidD » 18 Sep 2016, 11:11

Zini wrote:Because that is not how Morrowind works. Instances are kept in their original cells. We can't change that without breaking a whole lot of stuff (mods, the esp/esm format and so on).
Fair enough :D. Curious design decision from Bethesda

Post Reply

Who is online

Users browsing this forum: No registered users and 1 guest