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. :)

I much prefer text-based instructions than HTML-based ones. It's just easier to copy/paste from a text file and follow instructions, plus it means not having to open a browser window to view the instructions.

BUT, I still say go for it. Some coders might want to offer text-based and html based so that everyone is happy.

Make it generate images instead of text. :)

Text ones are fine for the most part as long as everything is seperated clearly. HTML would be much better though, if you can handle the reduce in speed. The copy pasting would depend on the CSS (i think), so it just depends on how you do it.

Useful, but not everyone would use it, so go for it.

As long as it doesn't add a tag-line (eg. powered by ??) and allows us to create our own templates - I'd be the first to say that I would use it.

If I had something like this already I'd be releasing more addons. :)

Just starting a list for you...

1. XHTML/CSS compliant -- the best thing about CSS is that you can turn it OFF and/or alter the layout. For example, someone created html instructions with text too small.
2. Use textarea for code
3. Use color to give people a quick overview of what is what eg. original vs. new

Good idea.

It is planned as a PHP script. Later, a friend of mine MIGHT make a C++ port - e.g. make it work as a win32 application.

I totally agree with you on this part.

Bleh... There are vBulletin coding standards. Does anybody here follow them? Some coders do, but most coders are just people who like to code, so many hacks, as you can see, have a badly formatted code. :( I don't think that everyone will follow manual making standards either.

Bad idea. When applying a mod, you need to copy paste. You cannot do that with a text that was converted to an image. -.-

Why wouldn't you like it if it would add a "generated by" in a footer or a meta tag? It would make the script better known. As far as templates go - maybe, but I suppose the template changes will be CSS-based only. Because you don't need much visual variations except colors and borders in such a simple file as HTML instructions, do you?

1. XHTML / CSS - Do not worry, every small piece of web software I make is XHTML & CSS compliant :)
2. Umm... Textarea does not show code indentations. Or does it? Because if it does not, then it would be a hard to read code.
3. What do you mean? Color where?

I'm not talking about the code--more like the layout/heading/etc ... eg. should we use 'Underneath Add' or 'Below Add' or just 'Replace With' ... following a set of standards can benefit everyone--even if it's just html instructions

I don't mind having the tag available for me to read (ie generator interface) ... I just don't like it when I'm obligated to add it the the finished product (ie. html instructions)

It sure does.

this is a personal preference -- this can be set via templates ... eg. original code (gray), modified code (yellow), important (red) etc

The engine will allow a choice from a set of options - {'Find', 'Underneath Add', 'Above Add', 'Replace With}.

I see. Well, I am going to make an option that will allow you to disable the 'generated by' text. However, since you are a coder, you might understand that it is likely that a coder would like to have a name on his product - so that people who use what is produces could easily open the homepage and download a copy for themselves.

Perfect! Thus, a code holder shall be a textarea.
What is even better is the fact that a textarea also supports colored text :)

LOL ... I think we're talking about 2 different things ... I don't mind adding my info on the instructions :) ... what I don't like is adding OTHERS to my products. eg. 'Instructions Generated by HTML Generator'

Download my GTP ALLOW GROUP TO READ TITLES/ NOT CONTENT installation file (link in sig) and you will see an example of what I mean by 'color coding'.

That's the point. :ninja:

I say go for it. Readmes are a butt pain to do however a very important butt pain to do.

If you dont mind me saying, the generated header, footer, content block openers, closers and areas should all be templates that the user can customize. Otherwize it becomes as much of a burden to tweak the HTML output as it does to just write your own - all I do is use the exact same shell and change the content accordingly.
I would also suggest a standard 'dont upload' folder that will hold the generated css and associated images.

The generator should only need to accept something like:
1- Project name
2- Version
3- Link & title to release thread
4- Bookmarks to intall, upgrade, uninstall, settings and quick start blocks (actually, each of these could be specified by settings)
5- An infinate number of information blocks

Templates should be something like:
1- Header
2- Navigation
3- Content block
4- Footer

THen each project should be persisted to the db where you can recall, edit and regenerate based on project.

Hope you dont think Im trying to tell you how to do it - Im more or less thinking aloud from my experience writing them (which isnt vast in any sense).

Anyhooo - hope any of these suggestions can help. I would use it for sure if it did.

O yea, on a side note, I second the dislike of copyright notices visible to the end user. Sure we all want our names up in lights - however I generally avoid installing or using anything with copyright notices. For 1, they make it easy to identify easy targets if security holes are ever discovered (though I know that isnt really the case here) for another - why bother? I dont need the hundreds that have installed my stuff to have to parade my name. If users want it - they know where they can get it... here ;)

Again, just my 2 yen (which doesnt add up to much with the exchange rate)... I hope it helps.

nJoy

Ok, then, I will not put it in footer, but instead in a 'generator' meta-tag where it is invisible :)

I do not intend to make an 'edit' feature in the first version, but maybe later I will if I come up with an easy way to store data in a text file in a way that a program can easily parse into blocks and display.

Just out of curiosity... why store it in a text file? You could get the benefits of version/edit abilities if was stored in a table.

Yes. But that would be an additional system requirement... Ok, then I will store the results in a table :)

OK, here is my list of what is there could possibly be to a hack. If anyone has anything to add, post here.

INTRO / INSTRUCTIONS
SQL QUERIES
FILE UPLOADS
FILE MODIFICATIONS
TEMPLATE UPLOADS
TEMPLATE MODIFICATIONS
PHRASE UPLOADS
PHRASE MODIFICATIONS

Is this it?

If you do, please make it a class/functions so I could interface it from APM :)

KirbyDE, could you please elaborate a little more on that? I cannot understand what you said.

If you are going to create such a "Hack Manual Generator", it would be nice if you could make its core functionality a class or functions, so it could be interfaced from other Scripts :)

Hooks ;)
Even tho I will create my own installer for templates/phrases/hooks, others might not bother.
And I will definetely be using this, I applaud the creation of this mod :)

How do you install hooks / plugins? I have not made any 3.5 hacks yet, so I do not know.

Thanks, but you are missing one: It is not a mod, but rather a stand alone application :)

it looks good thus far ... you should make it so that you can add a new field if needed

LOL, don't feel bad ... I have not even installed 3.5 yet. :)
I think I'll wait until it goes GOLD.

Check out admincp/plugin.php for the code they use to import plugins.

No, I mean, does anyone ever need to install hooks/plugins manually or does vBulletin have an integrated installer, which means a file upload?

vBulletin has the same Plugin installation interface as Phrases and Templates, so it would make no sense to create functions for those and not Plugins :P

Ok, whatever you say...

Should it also generate a text version along side of the html and bbcode ones?

P.S> Shame on you, there is a much easier way to store an array in a file than making a mysql structure for it...

I am done, please read here now:
https://vborg.vbsupport.ru/showthread.php?t=91941

LOL, you should've said from the start this will require licensing fee and a license key. :down:

Don't show me the down thumbs because it is not going to change anything. If you want to know, the actual fee will be very low ($14.99). -.- And the license key is only going to serve to receive free upgrades :)

And if you are still not interested, I can even provide you with a manual that was generated using this generator ;)

Added Later: By the way. If you think $14.99 is a big fee for this... Check out any of my hack manuals, and note the way they are formatted. Easy to read, isn't it? ;) Now, if my text-based manuals are easy to read, imagine what I made using XHTML + CSS, making use of all the special effects and formatting available. You cannot imagine? Your loss ;)

Ha! That depends solely on the layout. You def won't hate mine, plus it also generates a text version. xD

I agree.
That's pretty anal. $14.99 is not a very low fee. $5 is a very low fee. $14.99 is more than most semi-old PS2 games cost, unused, in the correct games stores (at least here in Norway. Currency roughly translated).
It is going to change everything. Before, me along with most others in this thread that do not know you personally voted and thought it would be released free, like so many other hacks that are much more extensive than this. And before you start saying "but this is not a hack like that, it's a hackers tool", then I say "exactly".
And for the script to call home to make sure no-one is creating manuals they shouldn't be creating.
I would be interested in seeing such a preview.
GeekyDesigns have a HTML based manual which is easy to read and has checkboxes that hides a block of code when it's done (IIRC, I know at least someone does have this). I highly doubt they would start a lawsuit if you took one of their manuals, redid the coding to suit your needs, and used it. I have a feeling this would piss you off to no ends if it was done to any of YOUR manuals.
So yeah, do show me an XHTML+CSS manual whos editing interface would make spending $15 worth the "hassle" of creating a blank "template" manual and fill this in manually at each hack release.

I'll recover from this loss in due time :)

Even $0.0 is too much with this licensing key scheme. There's a lot of coders here sharing their work without such restrictions, so it does look odd to charge for a simple script to format a post or a page as HTML or XHTML and require licensing keys for it.

Nothing against making money, and if anyone pays for it, more power to you. ;)

I can understand, nobody likes to pay. Including me. However, as a coder, you should understand that time costs money. And it was not a 5 minute job.

Suit yourself. Let's start with the fact that I don't think have to tell anything to anybody. Unless I signed a contract or unless I am in partnership with someone. Never said it was going to be free either. You assumed it.

I could do a call home. Thanks for the idea. Didn't think about it b4 you said it tho :)

https://vborg.vbsupport.ru/showthrea...threadid=91998
Text version is not included in that archive.

Wow! Really! How did they do it???
To speak seriously, thanks for the idea. I am going to implement that as well.
Now, speaking of large hacks... Are you going to write out all those IDs and checkboxes manually? Bleh. Even if you will, you won't ever have the patience to finish it as much as valid XHTML goes.

Wrong, son. You could use the HTML from any of my manuals. You could adapt it.... manually.... I have no problem with that xD.
At the same time, I will use the generator for my hacks which will save me a lot of time xD

Good for you. Congratulations.

Cheers!

Yet that didn't stop me from releasing the RPG for free, and keep doing so. I have spent close to a full year on the RPG by now. Granted, I haven't spent 24/7 on it, but still a fair amount of my time.
Common courtesy to give people all the info before you get them excited though ;)
No problem ;) I should warn you though, most people will hack that out, so you should either Zend or IonCube some of the core functions of the hack along with the call home function. Granted, you will sell less because either will require either Zend installed or Safe Mode disabled, but at least no-one will be using the script without you knowing it :)
Thanks, Ill check that out after submitting this post.


Care to make a small wager on that, mate? ;) You probably don't know it, but you are talking to a perfectionist. I rarely ever publish anything without it being XHTML. Current RPG templates are ++++ because I didn't have time or skills to redo them and still make the v3 release in a timely manner. I do now.
So you see, I have patience coming out various holes in my body ;)
Thanks, I'll take that offer. Means I'll have the vB3.5 compliant version of my hack with a shiny HTML manual as well as a .txt manual :) Provided I don't succeed in making it into a full-fledged Extension, that is ;)