[WIPRELz] TES3 Readme Generator

Post » Tue Sep 22, 2015 5:16 am

Thank you!

Ok, so it's just a simple numbered list, is there anything else about it that might be needed in a load order section? Perhaps the toggling of using a numbered list or not?

User avatar
Dustin Brown
 
Posts: 3307
Joined: Sun Sep 30, 2007 6:55 am

Post » Tue Sep 22, 2015 5:05 pm

Sometimes load list items only need to be in a certain sequence in relation to other mods but not each other, for example:

Mod1, Mod2Mod3Mod4

What this load order means is: first load Mod1 and Mod2, in whatever sequence (so it could be Mod1, then Mod2 as well as first Mod2 and then Mod1), then load Mod3 and after that Mod4.

It could be handled by adding "(in whatever sequence)" to lines with this kind of mods.

User avatar
Joe Bonney
 
Posts: 3466
Joined: Tue Jul 17, 2007 12:00 pm

Post » Tue Sep 22, 2015 8:19 am

Aah, thank you Skrawafunda! I'll probably implement this after the other two major features are in.

User avatar
Sasha Brown
 
Posts: 3426
Joined: Sat Jan 20, 2007 4:46 pm

Post » Tue Sep 22, 2015 12:24 pm

Updated to version 0.9.1! You can now save and load readme's for later editing!

You can also use a folder browsing dialog for selecting the default saving and generation paths; amongst other small tweaks and improvements.

User avatar
Crystal Clarke
 
Posts: 3410
Joined: Mon Dec 11, 2006 5:55 am

Post » Tue Sep 22, 2015 12:35 pm

Not sure if this is something you already have, brucoms, but have you seen Wrye's http://wryemusings.com/WML%201.0.html? Maybe having options to pick from these could be useful...
User avatar
Marlo Stanfield
 
Posts: 3432
Joined: Wed May 16, 2007 11:00 pm

Post » Tue Sep 22, 2015 3:46 am

Ooh, thanks for the link Dragon. I'll see about incorporating the info in a later update.

User avatar
Becky Cox
 
Posts: 3389
Joined: Thu Jun 22, 2006 8:38 am

Post » Tue Sep 22, 2015 4:17 pm

Any chance in a preview pane any time soon? It'd really make the application complete for me. :)

User avatar
Chrissie Pillinger
 
Posts: 3464
Joined: Fri Jun 16, 2006 3:26 am

Post » Tue Sep 22, 2015 9:04 am

Don't worry, it's coming in the next update! :)

User avatar
Beast Attire
 
Posts: 3456
Joined: Tue Oct 09, 2007 5:33 am

Post » Tue Sep 22, 2015 2:54 pm

Yay! :D

User avatar
Cheville Thompson
 
Posts: 3404
Joined: Sun Mar 25, 2007 2:33 pm

Post » Tue Sep 22, 2015 5:24 am

Two small suggestions:

When opening a previously generated esr file in which we chose one of the predefined options ("Modify my mod without credits or permission", "Need permission to modify my mod", etc.), the Permissions section's custom text area gets filled with the text, even if its just this predefined option. I think it would be worthwhile to have the application recognise these predefined options and not put them into the custom text area.

And the other thing, when opening a previously generated esr file in which we chose a Title separator other than hyphen ("-"), the application opens it always as a hyphen anyways. So if I initially set, for example, the equation mark ("=") to be the separator, saved it as an esr, closed the application and then launched it again and opened the esr file, it would revert back to a hyphen. Note that the problem exists only in separate sessions of the application, in a single session it doesn't revert. (This could be seen as another issue - title separator preference is not saved properly).

Update: I've found a bug: I was working with two esr files, both having a custom section "Load Order"; the two files had different text in this section. If I opened the first file and then opened the second file and then generated the readme for the second file, two possible things could happen with the custom section:

1) If I didn't click on the custom section while doing anything in the first file, everything would be okay

2) However, if I did click on the custom section and then proceeded to open the second esr, the contents of the first esr's custom section would remain. Generating a readme after that from the opened second esr would erringly contain the custom section from the first esr. It can be avoided by clicking on the custom section again - it then updates properly and prints out the correct text when readme is generated.

User avatar
loste juliana
 
Posts: 3417
Joined: Sun Mar 18, 2007 7:37 pm

Post » Tue Sep 22, 2015 3:00 am

Ack! My apologies, bugs that should have been spotted before release!

Ok, I'm going out in a minute, but I've already been able to reproduce your second point. This was an oversight on my part and involves and very quick fix. The first and third points I haven't had a look at yet. I'll update this post once I've got time to perform tests.

User avatar
Killah Bee
 
Posts: 3484
Joined: Sat Oct 06, 2007 12:23 pm

Post » Tue Sep 22, 2015 3:25 pm

If you need any more info on the things I've mentioned, just ask.

And an idea: when editing more verbose readmes I find the text input fields tad too small. Would making their size adjustable be a bothersome addition?

And another one! In 'Section order' part, since the number of sections can be rather numerous, moving sections may be cumbersome to do by mass single-clicking. Especially so when adding a custom section which you'd like to move to the top of the order list (since custom sections appear at the bottom).

It would be much more convenient if instead of having only an option to single-press the button we could have another one for pressing the arrow button (in the application) for longer time - with an effect of moving the selected section in the destination of the arrow.

I am not sure if I expressed the idea correctly here. If it's unclear, please say so xD

User avatar
Katie Louise Ingram
 
Posts: 3437
Joined: Sat Nov 18, 2006 2:10 am

Post » Tue Sep 22, 2015 6:18 am

adding to what Skrawafunda says, could the description area accept tab command or may be bulleting ? I don't know what I ask is possible, but it makes the readme more readable if salient features were listed in bullet form. Not the full fledged bullet option, just the one looks like bullets like this :

Small description	- feature 1	- feature 2	- feature 3	- feature 4	etc.
User avatar
lolli
 
Posts: 3485
Joined: Mon Jan 01, 2007 10:42 am

Post » Tue Sep 22, 2015 12:50 pm

I like this suggestion!

I have just found another bug. When working in a single application session I was editing two readmes. When I switched from the first one to the second (via opening esr files) the first one's Changelog, Contact, Uninstall, Updating, Known Issues or Bugs fields remained. So every field that the second readme did NOT have was filled with first one's leftover content.

Update: I've tested the issue with other readme esr files. Indeed, whenever a previous readme had a field that the newly opened one did not have, the content from the previous one would be left over in the field.

User avatar
Mason Nevitt
 
Posts: 3346
Joined: Fri May 11, 2007 8:49 pm

Post » Tue Sep 22, 2015 6:44 am

Version 0.9.6.1 released! Mostly fixes for the issues found by Skrawafunda. Thanks for your help! :)

The first two issues have definitely been fixed. I'm not 100% sure on the third issue as I haven't been able to reproduce it myself. So please feedback if it's been fixed or not.

I'm not too sure on the re-adjustable size bit; I'll have a look, but I may have to rebuild the GUI to get it to work. The arrow hotkeys should be simple enough to add.

I'll see if I can add it, but the rich text areas may not be advanced enough to allow it. Unless I could extend their functionality myself...

Data should now be properly clearing when loading up a second readme within the same session.

User avatar
Chloé
 
Posts: 3351
Joined: Sun Apr 08, 2007 8:15 am

Post » Tue Sep 22, 2015 7:41 am

Title separator works fine now, however I am still getting the first issue, the one with Permissions.

Screenshot of situation on the moment of saving the esr - http://imgur.com/DEI0Yb6,yCk0Mmb#1

Screenshot of a situation on the moment of opening the previously saved esr - http://imgur.com/DEI0Yb6,yCk0Mmb#0

As for the third issue, it has been solved :smile:

Ah great, data properly clears now indeed.

Thank you for your continued development of the application. It is of great use!

User avatar
tannis
 
Posts: 3446
Joined: Sat Dec 09, 2006 11:21 pm

Post » Tue Sep 22, 2015 8:02 am

Fantastic news!

Is that previously saved esr saved with an older version? If so then that's the issue here. Once you have saved it again with the new version (and made sure "Other persmissions?" is unchecked) then you should be golden. :)

User avatar
Taylah Illies
 
Posts: 3369
Joined: Fri Feb 09, 2007 7:13 am

Post » Tue Sep 22, 2015 5:48 am

Version 1.0.0pre has been released!

I've done quite a bit of refactoring to the code. Nothing that improves performance (not that it needs it), but rather to ensure that it's easier to come back to at a later date.

The important features that have been added are: a preview tab, and the arrow keys can be used to reorder the sections.

While TES3 Readme Generator is close to being finished, there are still a few features that I would like to implement. Such as a separate load order section.

User avatar
Matt Bee
 
Posts: 3441
Joined: Tue Jul 10, 2007 5:32 am

Post » Tue Sep 22, 2015 3:06 pm

'tab' works in text boxes. :D It allows for greater flexibility. Thank you. :icecream:

User avatar
Roddy
 
Posts: 3564
Joined: Fri Jun 15, 2007 11:50 pm

Post » Tue Sep 22, 2015 7:31 am

No problem! The tab order should be fine, but let me know if there's any oddities in the ordering.

User avatar
Antony Holdsworth
 
Posts: 3387
Joined: Tue May 29, 2007 4:50 am

Post » Tue Sep 22, 2015 5:13 am

It's been just over a month since my last post, I think we're over due on an update!

While implementing the new Load Order section, I was getting really frustrated at how messy and cobbled together it all was. I was also limited at how I could implement certain features (e.g. resizing the text boxes), and while I could have just refactored the whole lot it would have been too time consuming. Plus, if I'm going to refactor almost the entire codebase, I may as well start from scratch with everything that I have learned.

So, here I am with the new and improved TES3 Readme Generator (well, not quite yet :smile: )! It's not too different visually, but I have got the new Load Order tab and I've moved Custom Sections to its own tab. It was a bit silly of me to squeeze such an important element at the bottom of the Other tab. The important bit is that know that I have implemented everything a little better (plus WPF, etc), it should be a lot easier and faster (and less frustrating) to implement new features.

You can look forward to version 2 of TES3 Readme Generator soon! Though I suppose it should be version 1 considering what would have been version 1 never reached full release...

For the programmers out there (and for those interested in the technical side); the first version of the Generator was built within WinForms, this new version is built with WPF (Windows Presentation Foundation) and using the MVVM (Model View ViewModel) pattern. If you want to have a look, follow this link to the public repository: http://gitlab.theassimilationlab.com/brucoms/tes3readmegen2 (Thank you to http://www.theassimilationlab.com/ for hosting!). You can clone the repo and do what you like, however, please credit me as the original author if you do release something.

User avatar
Jack Moves
 
Posts: 3367
Joined: Wed Jun 27, 2007 7:51 am

Post » Tue Sep 22, 2015 11:06 am

Oh, and I just used the last version for generating the readme of my skies.. :P

I do have a bit of feedback from that release, if you're interested.

  • There's no option to have a completely custom permissions section. If you select one of the options from the dropdown, then check the checkbox and write in the custom field, whatever you selected from the dropdown will still show up. There should be a blank, or "other" option in the dropdown, which auto selects the custom permission checkbox. This way a modder can specify their own permissions if a simple sentence from the dropdown doesn't work in the context of their mod.
  • It'd be neat if the generator was able to save in a format it could open at a later date. I realize this may not be easy to implement, but it could be useful for making updated readmes for newer versions of the mod. As it is now, if I wanted to make an updated readme, I'd have to manually copy-paste all the relevant text back into the generator from an old readme. At that point one may as well just use a text editor, which pretty much nullifies the readme generator.
  • having nothing in the separator field generates an error message. Luckily this doesn't crash the program but it's kind of inconvenient. Especially considering deleting what's in there in order to input something new can generate the error. I'd recommend having the program automatically input a space in the field if it's left blank.
  • The Preview pane was very useful, I'm glad it got implemented. :)

Will try the new version soon, probably for whatever else I release next, which'll probably be reuploads of my existing mods...

User avatar
DAVId Bryant
 
Posts: 3366
Joined: Wed Nov 14, 2007 11:41 pm

Post » Tue Sep 22, 2015 6:13 pm

Ooh, feedback! :D

I'll go point-by-point:

  • That's a far better method than what I have it as now. I'll change that section to what you've suggested.
  • The currently released version can already save and open readme's in a separate format. Though I admit it is a bit hidden away for something vital. To find it you'll need to go to File in the top-left corner (the usual CTRL-S shortcut works too). Actually, thinking about it, saving/opening is a bit limited (e.g. there's no "Open recently edited..." option), and will need expanding.
  • Ooh, I missed that error. The new version has that preference as a drop down menu instead. Solves any null errors that crops up currently.
  • Glad you like it! That reminds me, I should probably get around to implementing it in the new version...

Thank you for the feedback starwarsgal!

User avatar
Catharine Krupinski
 
Posts: 3377
Joined: Sun Aug 12, 2007 3:39 pm

Post » Tue Sep 22, 2015 11:58 am

Version 1.9.0 has been released for testing! The OP and Nexus pages have been updated.

At the moment settings in the preference tab are not saved between user sessions; plus some of the UI is not yet complete (e.g. Custom Sections tab).

Changes in 1.9.0

  • Rebuilt with WPF using the MVVM pattern
  • Added: Load Order section
  • Changed: Moved Custom Sections to its own tab
  • Changed: Improved UI
  • Many other improvements and tweaks
  • Issue: Preferences are not currently saved
  • Issue: Automatically opening the readme after generation is broken
  • Issue: Readme contents section is broken

If you want to take a peek or make a contribution please visit one of these links:

  • http://gitlab.theassimilationlab.com/brucoms/tes3readmegen
  • http://gitlab.theassimilationlab.com/brucoms/tes3readmegen2

The bottom link will take you the the newest version of TES3 Readme Generator. That's the version built with WPF instead of WinForms.

User avatar
saharen beauty
 
Posts: 3456
Joined: Wed Nov 22, 2006 12:54 am

Post » Tue Sep 22, 2015 4:59 am

Thank you again for yet another update :)

I had not used this for a while and really liked the newer version (the one from the Nexus) . The load order section in particular.

I could not change the path to generate/save the readme, but it is possible I was just not doing the right thing (I clicked on the '...' )

User avatar
Hayley Bristow
 
Posts: 3467
Joined: Tue Oct 31, 2006 12:24 am

PreviousNext

Return to III - Morrowind