Hack Manual Generator

[Tony G]

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.

[Adrian Schneider]

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.

[Princeton]

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

[akanevsky]

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

Good idea.

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

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.

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
if done correctly, 'html' instructions can reduce installation problems/questions posted by newbies*

I totally agree with you on this part.

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.

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.

Make it generate images instead of text.

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

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.

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?

Just starting a list for 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?

[Princeton]

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.

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

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?

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)

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.

It sure does.

3. What do you mean? Color where?

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

[akanevsky]

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

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

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)

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.

It sure does.

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

[Princeton]

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.

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'.

[Adrian Schneider]

Originally Posted by Well it wasn't me

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

That's the point. :ninja:

[The Geek]

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

[akanevsky]

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.