Ludeon Forums

Ludeon Forums

  • August 05, 2021, 08:01:29 AM
  • Welcome, Guest
Please login or register.

Login with username, password and session length
Advanced search  
Pages: 1 2 3 [4] 5 6

Author Topic: XML Auto-Documentation  (Read 79378 times)

Spdskatr

  • Colonist
  • ***
  • Posts: 383
  • Practically lives in the Discord server
    • View Profile
Re: [A16] XML Auto-Documentation for 0.16.1393 rev540
« Reply #45 on: March 17, 2017, 07:06:04 AM »

Sorry for the belated reply - I haven't had time to dig into the XML to see what you're referring to. If you're asking for specific documentation of what it does, that would defeat the purpose of it being an Auto Doc. If you're asking for more detailed analysis/use of compProperties, could you elaborate a bit on what you're looking for?
Basically, in the same way you did ThingDef, maybe create a similar Autodoc for BuildingProperties and CompProperties, maybe StuffProperties (Include field names, where it is found)? Someone on discord was talking about how these classes were often used in defs without any proper documentation in the autodoc so I thought I would pass it over.
Logged
My mods

If 666 is evil, does that make 25.8069758011 the root of all evil?

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A16] XML Auto-Documentation for 0.16.1393 rev540
« Reply #46 on: March 17, 2017, 03:02:45 PM »

Ah, okay.  Thanks for passing that along.  I haven't been on Discord yet, and probably won't get into that, tbh.  I'm willing to add more parsing/tracking, but I need a little clarity yet.  (Sorry if I'm being thick-skulled here; I'm just still not getting it.)

Here's what I understand: According to the A16 XML, there's only 3 different attributes that show up in Core as Class="???Properties_..." and they are ALWAYS applied to a <comps><li ... > tag.  They are:
  • CompProperties_...
  • HediffCompProperties_...
  • StorytellerCompProperties_...
(Note: There is no BuildingProperties or StuffProperties in the A16 XML.  If you're referring to something that isn't public knowledge, please PM me rather than posting it publicly.)  The point of this isn't manual documentation, but I don't think that's what you're after.  These attributes are all grouped under comps<li> and they shouldn't be that hard to find.  Their names give really good clues as to what they do.  So what exactly are you asking me to track?  Again, I'm willing to make it happen, I'm just not sure what I'm being asked for.

Spdskatr

  • Colonist
  • ***
  • Posts: 383
  • Practically lives in the Discord server
    • View Profile
Re: [A16] XML Auto-Documentation for 0.16.1393 rev540
« Reply #47 on: March 19, 2017, 03:03:40 AM »

Ah, okay.  Thanks for passing that along.  I haven't been on Discord yet, and probably won't get into that, tbh.  I'm willing to add more parsing/tracking, but I need a little clarity yet.  (Sorry if I'm being thick-skulled here; I'm just still not getting it.)

Here's what I understand: According to the A16 XML, there's only 3 different attributes that show up in Core as Class="???Properties_..." and they are ALWAYS applied to a <comps><li ... > tag.  They are:
  • CompProperties_...
  • HediffCompProperties_...
  • StorytellerCompProperties_...
(Note: There is no BuildingProperties or StuffProperties in the A16 XML.  If you're referring to something that isn't public knowledge, please PM me rather than posting it publicly.)  The point of this isn't manual documentation, but I don't think that's what you're after.  These attributes are all grouped under comps<li> and they shouldn't be that hard to find.  Their names give really good clues as to what they do.  So what exactly are you asking me to track?  Again, I'm willing to make it happen, I'm just not sure what I'm being asked for.

Part 1 was: To possibly make another section for each CompProperties class so for example:

Class="CompProperties_Art"
Fields:
  • nameMaker (text: foo, bar)
  • descriptionMaker (text: foo, bar)
  • minQualityForArtistic (text: foo, bar)
  • mustBeFullGrave (text: foo, bar)
  • canBeEnjoyedAsArt (text: foo, bar)
  • compClass (text: foo, bar)
Examples:
(same as normal)



Part 2: I actually checked the newest version, this is already implemented under <building> and <stuffProps>. No further action needed :)
Logged
My mods

If 666 is evil, does that make 25.8069758011 the root of all evil?

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A16] XML Auto-Documentation for 0.16.1393 rev540
« Reply #48 on: March 19, 2017, 09:38:10 PM »

Okay, I think I get what you're saying now. And that would probably be very useful to have. I'll think on it this week and do a little tweaking. I should have an update by the end of this week. Please bug me about it if it looks like I've forgotten (I do get sidetracked at times).

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A16] XML Auto-Documentation for 0.16.1393 rev540
« Reply #49 on: March 22, 2017, 01:39:27 PM »

Okay, I made a test build of the above.  It now parses separately any "special" tag (currently just <li> and <defName>) with an attribute containing 'Properties_' .  That seems to catch all of the various CompProperties without grabbing anything else.

Here's the test build (not updated on the main page): https://www.dropbox.com/s/q896td291evktld/CoreXML%20A16%20Test.html?dl=0

Let me know if that's what you're looking for, and if it's useful.  I don't want to get lost in the feature-creep end of things either.  ;)

Oh, and how's the overall formatting & usability?  Anyone have ideas how to improve the layout?  Having two pseudo-columns via Float in a >1MB HTML file isn't exactly ideal, but it's the best I can think of to allow independent vertical scrolling.

Spdskatr

  • Colonist
  • ***
  • Posts: 383
  • Practically lives in the Discord server
    • View Profile
Re: [A16] XML Auto-Documentation for 0.16.1393 rev540
« Reply #50 on: March 28, 2017, 10:10:02 PM »

Okay, I made a test build of the above.  It now parses separately any "special" tag (currently just <li> and <defName>) with an attribute containing 'Properties_' .  That seems to catch all of the various CompProperties without grabbing anything else.

Here's the test build (not updated on the main page): https://www.dropbox.com/s/q896td291evktld/CoreXML%20A16%20Test.html?dl=0

Let me know if that's what you're looking for, and if it's useful.  I don't want to get lost in the feature-creep end of things either.  ;)

Oh, and how's the overall formatting & usability?  Anyone have ideas how to improve the layout?  Having two pseudo-columns via Float in a >1MB HTML file isn't exactly ideal, but it's the best I can think of to allow independent vertical scrolling.

Perfect. Thanks, this is great.

Also, usability is fine, considering this is auto-documentation.
Logged
My mods

If 666 is evil, does that make 25.8069758011 the root of all evil?

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A17] XML Auto-Documentation for 0.17.1546 rev891
« Reply #51 on: May 25, 2017, 11:00:24 AM »

Alpha 17 auto doc is released.  I'm tracking all CompProperties attributes separately, and it seems to come out well.  Enjoy!

kaptain_kavern

  • Planetologist
  • ****
  • Posts: 2074
  • started 10 mods in one tick.
    • View Profile
    • RimWorldMod Slack - A place for live chatting about RimWorld modding
Re: [A17] XML Auto-Documentation for 0.17.1546 rev891
« Reply #52 on: May 25, 2017, 11:05:05 AM »

Hey Milon you made us waiting long this time  ;D

THANK YOU very much for this, as usual.

You rocks, buddy !

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A17] XML Auto-Documentation for 0.17.1546 rev891
« Reply #53 on: May 25, 2017, 11:07:00 AM »

Wow, you jumped on this fast!  Glad to be of help, and sorry I kept you waiting a couple hours, LOL!  ;D

FYI, I haven't learned the new field-replacement technique for A17, but there either is or will be documentation coming out about that.  Some of the other modders were putting that together during A17 testing.

Finally, there's a new A17 mod announcement sticky thread:
https://ludeon.com/forums/index.php?topic=32817.0

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A17b] XML Auto-Documentation
« Reply #54 on: June 08, 2017, 08:46:39 PM »

Updated to A17b

DestroyX

  • Drifter
  • **
  • Posts: 67
  • Refugee
    • View Profile
Re: [A17b] XML Auto-Documentation
« Reply #55 on: October 11, 2017, 04:04:59 AM »

Omg i love you dude!
Logged

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #56 on: November 20, 2017, 07:09:22 PM »

Updated to A18.  I haven't *touched* A18 yet, beyond downloading and running the Auto-Doc on it.  I'm still "on vacation" because IRL is insane in milon-land.  Please PM me if there's any weirdness or anything else I should be alerted to.

Enjoy!

Dfid

  • Muffalo
  • *
  • Posts: 2
  • Refugee
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #57 on: November 20, 2017, 07:31:20 PM »

Updated to A18.  I haven't *touched* A18 yet, beyond downloading and running the Auto-Doc on it.  I'm still "on vacation" because IRL is insane in milon-land.  Please PM me if there's any weirdness or anything else I should be alerted to.

Enjoy!

I know it seems kinda nickpicky but it isnt A18 its B18 now.
Logged

kaptain_kavern

  • Planetologist
  • ****
  • Posts: 2074
  • started 10 mods in one tick.
    • View Profile
    • RimWorldMod Slack - A place for live chatting about RimWorld modding
Re: [A18] XML Auto-Documentation
« Reply #58 on: November 20, 2017, 08:04:52 PM »


Enjoy!

As always, many thanks man. You know I nearly started to think about how to do one myself this time? ;-)

And good luck with the IRL. It is what matters in the end

Cheers

larSyn

  • Developer
  • Colonist
  • *****
  • Posts: 150
  • Refugee
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #59 on: November 21, 2017, 09:43:13 AM »

Updated to A18.

Nice. Thanks!  These are essential. 

Also want to say good luck w/ IRL. kaptain is right about it.

Logged
Pages: 1 2 3 [4] 5 6