Hack Manual Generator
 

What do yall think about a thingy that would generate a pretty-looking HTML modification manuals (like the ones Logician makes) based on the input you put into the software. Why? Because most people make messy text-based manuals (inluding me), just because it takes too much time to hand-write an HTML-based manual.

I prefer Textfiles, much easier to handle then HTML IMHO.

Just my 0,02 €

I hate html install instructions with a passion. I much prefer plain text.

html ones are fine, as long as you don't need to copy any code from them - that's a nightmare.

Ouch! What can I do for 0,02 €??? I can't even buy myself an ice-cream. ://

Why? Not that I want to prove you wrong (because I don't), I just wanna understand your point of view ;)

How is that a nightmare? AFAIK, it is only a nightmare when you use wordpad. If you use something like a "Professional Notepad" or "Notepad++" or "UltraEdit32", you get no problem with formatted text, if that's what you talking about ;)

Working from HTML install files isn't as easy as copying and pasting from text files. Plus, it means opening a bulky browser window instead of another tab in my text editor.

Amy

I usually prefer that my hack's thread contains the detailed instructions, and some are quite verbose if the hack is intricate. I don't include additional instructions, because I'm lazy with docs, so I'd find your tool quite handy. :up:

Not sure what method you'd use, but maybe it can generate the manual by preference, either text, html, or bbcode (or all), based on the user's settings? Then I'd generate the manual with the tool, cut and paste the bbcode into the hack's thread, and save the html and text to include in the zip file. Just throwing some idea...

Hmm.. Ok. I, personally, never have more than two tabs open in my browser ;P

That's nice, but boards do not have such bbcodes as "inset div" or "horizontal line" by default. Furthermore, not all boards have a PHP tag. For example - invisionboard or phpbb ://... The idea of TEXT-OR-HTML option is useful, though :)

bbcode can still be done if you allow config options to define translations of bbcodes.

Is this planned as PC software or as an online tool?

I say go for it!

1. text files are fine for the experienced ... but, 'html' instructions are best for the inexperienced ... Presentation is the key factor why 'html' is best for the whole
2. if done correctly, 'html' instructions can reduce installation problems/questions posted by newbies*

* experienced coders know what to do if they run into a problem - hence, they are less likely to post 'problems' that do not exist

You should inquire with the staff here and see if they can come up with some rules/standards for the community. It will make your job easier. :)