Creating markdown spec

[pencerw]

This pull request formalizes my proposed draft for the Core Spec. The core spec here is in markdown with the standard sections linked to spec_resources files, as it seems that is the direction we're going.

Note that there are multiple open issues with this repository, which should be cleared prior to it being made public. Some of these are related to formatting, some are related to content. However, this pull request CAN be merged before those issues are addressed.

@KrisIverson can you review this PR by comparing against the (included) Word document?

[KrisIverson]

I promised to do this review but have several outstanding issues on the Materials spec that I need to clear out before I can get back to this. I am hoping to have that done in the next few days. I am a little concerned that we proposed other changes in the Core spec that will need to be merged into this new version and I feel a little overstretched tracking what changes are going where. No doubt that will ease when we have master documents moved over to markdown.

-K

From: Spencer Wright notifications@github.com Sent: Thursday, July 12, 2018 9:04 AM To: 3MFConsortium/spec_core spec_core@noreply.github.com Cc: Kris Iverson Kris.Iverson@microsoft.com; Mention mention@noreply.github.com Subject: [3MFConsortium/spec_core] Creating markdown spec (#6)

This pull request formalizes my proposed draft for the Core Spec. The core spec here is in markdown with the standard sections linked to spec_resources files, as it seems that is the direction we're going.

Note that there are multiple open issues with this repository, which should be cleared prior to it being made public. Some of these are related to formatting, some are related to content. However, this pull request CAN be merged before those issues are addressed.

@KrisIversonhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FKrisIverson&data=02%7C01%7CKris.Iverson%40microsoft.com%7Cd7926ad681624a01425808d5e81111e7%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636670082374110131&sdata=RAOR8h4NJZUwJhvN4PxDm0oS0vNq2feLyR5CFGL%2BFHE%3D&reserved=0 can you review this PR by comparing against the (included) Word document?

---

You can view, comment on, or merge this pull request online at:

https://github.com/3MFConsortium/spec_core/pull/6https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2F3MFConsortium%2Fspec_core%2Fpull%2F6&data=02%7C01%7CKris.Iverson%40microsoft.com%7Cd7926ad681624a01425808d5e81111e7%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636670082374110131&sdata=BBk44tC77fgMXOrlK6lYhqY1NoeSNyMPrMrzspjV0lE%3D&reserved=0

Commit Summary

• created readme
• writage conversion - untested
• renaming spec to show that it's from writage, (temporarily) adding docx file
• updating core spec with Kris's proposal
• added word2markdown version
• working on w2m version
• working
• escaping xml tags
• editing matrix table
• adding images
• model image
• name of model image needed?
• image filenames can't have spaces?
• underscores it is!
• no empty image name
• wrong slash :/
• linking images into the spec
• close paren on those images
• figure 2-1
• figure 3-1
• notes
• escaping all of the xml tags
• tables
• table 3-1, correct xml escape
• item element tables
• span tables?
• tables
• element

[pencerw]

Thanks, @KrisIverson. Note, I've been tracking issues for all specs using GitHub's issues feature. I added a few to the Core spec recently here, and it looks like you posted two early in June: https://github.com/3MFConsortium/spec_core/issues I would recommend anyone in @3MFConsortium/contributors who knows of additional changes/issues to post them there and clear up that headspace!

[pencerw]

@3MFConsortium/contributors The changes here have addressed all issues that have been brought to my attention:

• Images have a max width of 750 px
• All headings are numbered
• All boilerplate sections are included so that extensions can link here

I would like to merge this PR tomorrow so that @jordig100's CT_Resources changes can be added before he leaves for vacation. I will create the table of contents right before we make the spec public.

If you have a half hour to read through this, please do so ASAP!

[jordig100]

Spencer, I found 12 places where there are references to sections. Just look for word "see". We might replace them by an hyperlink to facilitate navigation.

The "see" occurrence in "3.4.3.1. Item Element" has some estrange symbols: (see §4.2, "Components")

For the diagrams, to ones showing large fonts, I'd reduce them in size. For this is just cosmetics.

For the rest I'm fine. Jordi

[pencerw]

@jordig100 thanks! just fixed the symbol in 3.4.3.1.

Hyperlinks are a good idea as well. Do you think it's okay to log that as an Issue that we can address after this PR is merged? If so, can you create the issue and assign it to me?