| Author | Comment |
Vectris
Ultralisk
Posted: 8 Oct 2008
17:10 GMT
Total Posts: 375 | Manual Generator is a program that will allow you to input key information for the documentation of a program or game and will then output an extremely neat, organized, and ASCII Graphical txt Manual.
(Graphics are perfect borders and boxes for the main information, as well as perfect alignment)
This program could revolutionize the manuals in calculator programs if we can get people to use it. The main reason for the production of this program is because so many of the documentations for programs are terrible and lack the information that people look for in the first place. To make my program user-friendly, I made many things un-checked by default as not everyone wishes to enter in every bit of data about there program in the manual, but for those who do the option is there.
This program is currently being tested by me and will be released to testers to check for further bugs.
Outputted .txt
Here is the .txt that my program will output.
Template for all outputted .txts
Screenshot
Current Progress
I have finished what I call the "BETA" version of the program. I will ask for testers in a few days.
Stay tuned to this topic because I will need several Beta Testers before I release it to the public. Also I will add update posts to this topic every now and then as well as ask you guys' opinions on things. |
gulyman
Goliath
Posted: 9 Oct 2008
14:16 GMT
Total Posts: 144 | That's pretty cool. What language are you using?
Could the "type of variable" table have a drop down list so you could select the type of veriable instead of typing it in? |
Vectris
Ultralisk
Posted: 9 Oct 2008
14:50 GMT
Total Posts: 375 | I'm programming in VB.net with vb 2005.
And thanks for the suggest, I can definitely add that. In fact making it a Drop Down Box will decrease a fair amount of the coding I was going to have to do for it, thanks. I'm also making the calc type a drop down box.
Oh and can you think of a better way to say "Calculator Type:", I feel like there's something that sounds better than that but I can't think of it. |
Vectris
Ultralisk
Posted: 9 Oct 2008
18:37 GMT
Total Posts: 375 | Oh, and can someone check the contents of my drop down box lists? I want to make sure that I have all the possibilities for each one.
For CalcType:
TI-73
TI-82
TI-83
TI-83+/SE
TI-84+/SE
TI-86
TI-89
TI-89Ti
Voyage 200
For Variable Type:
Complex
GDB
Group
List
Matrix
Picture
Program
Real
String
Table |
gulyman
Goliath
Posted: 9 Oct 2008
20:52 GMT
Total Posts: 144 | Ummm...
how about "Calculator Model:" or "Model Number:"
I think that it's cool that your school does programming. I had to do a special project in order to learn some C++. They let me use an old stand alone computer that wouldn't screw up the network if I did something stupid.
You could do what Google does and release the program as a Beta. Then if some one needs a type of variable not on the list, you can blame it on being in Beta.
Would Apps be a variable? |
Vectris
Ultralisk
Posted: 9 Oct 2008
21:38 GMT
Total Posts: 375 | I think I'll go with "Calculator Model:", thanks for the good idea. I guess I could add Apps because some people make BASIC programs and then convert them into an app somehow. There are very very very few though, but still it's a possibility. For people who seriously made an Assembly program that's an app, they would probably want to design there own manual as it could only be something big like MirageOS or xLib or something.
Perhaps I should add AppVars too.
Oh, I added the Calc Model drop down box but now I need to make one for Program Type: ASSEMBLY Game, ASSEMBLY Program, TI-BASIC Game, TI-BASIC Program, or Application >.>
Also, I was going to make an Other for the Variable drop down box so that you can specify a custom variable, but I realized it's going to take up a ton of space and hard coding to get that part to work, it's a lot easier if I can have everything preset, maybe even include the Other option but make it show up as Other, not allow the person to custom name it themselves. |
me2
Goliath
Posted: 10 Oct 2008
09:06 GMT
Total Posts: 171 | You need to add the TI-85, TI-92 and TI-92+ calc models. And I agree that you should add appvars. I think this program is a good idea. I hate readmes that can't be read. I won't need it, but I have seen some that do.
---
<--- Going out with a bang. |
john777
Ultralisk
Posted: 10 Oct 2008
11:29 GMT
Total Posts: 289 | I don't know if you had a vision for this to be calc specific but you could also include windows or dos for computer stuff as a variable. I'm going off of what this site offers for options in the drop downs at the top of the page. That might mean more work for you though if you have to include all of the different programing languages. |
Vectris
Ultralisk
Posted: 10 Oct 2008
14:56 GMT
Total Posts: 375 | Ya, at first I was going to avoid the computer options, however I think that if I simply change the "Calculator Type:" to "Program Type:" (well maybye something better" I can include the computer options as well.
The only thing is that I have two drop down boxes (CalcModel and ProgramType) that need to be universal for both calculators and computers.
I can change CalcModel to something like "Programmed for:" and that should work, if someone has a better name though please post.
But the Program Type drop down is going to have a problem. I suppose that I can change the contents of it based on whether you chose a calculator model or a computer model. But do you think it would be ok to leave every option in the Program Type drop down box, regardless of what it's for? If you did a computer program than you could just choose Application as the program type and that would work, right? I don't know, maybe I should change the contents of the drop down box based on whether it's for the calc or computer. It should actually be pretty simple, I just have to find the properties for it, so if someone can post what I should list for hte possibilities of a computer program that'd help. I can only come up with Application really.
Also I decided to go ahead with allowing the user to select Other from the variable drop down menu and enter in there own custom variable type. It will take a little more coding but I found a slightly easier way to do it. |
gulyman
Goliath
Posted: 10 Oct 2008
17:50 GMT
Total Posts: 144 | I think having the "Other" variable show as other is a good idea.
So what were you doing in CP class before you started this? |
Vectris
Ultralisk
Posted: 10 Oct 2008
18:02 GMT
Total Posts: 375 | Bah, boring stuff. We're still going along but I finish all the assignments the first day and he gives us about 3 days per assignment. We just got to variables last week so it's a bunch of calculating simple things. We did a ton of calculating prices of something based on the quantity of each item inputted by the user. We just went up a level to calculating compound interest, although there's a function for that so it's easy. I actually didn't use the function though... I just used a while statement with the number of years as the variable, lol.
As for the drop down boxes situation, I made/coded it already and it works great.
Programmed For:
TI-73
TI-82
TI-83
TI-83+/SE
TI-84+/SE
TI-85
TI-86
TI-89
TI-89Ti
TI-92/+
Voyage 200
Windows 95
Windows 98
Windows 2000
Windows XP
Windows Vista
Other
Program Type:
TI-BASIC Game
TI-BASIC Program
ASSEMBLY Game
ASSEMBLY Program
Application
Shell
Game
Other
I also included code that detects if the first 3 letters of the programmed for are TI- so that I can add the, like programmed for the TI-84, otherwise programmed for the Windows 2000 sounds retarded. Also added something to change a to an if the program type begins in a vowel. I forgot to include the programmed for and type in the sample.txt, but here's an example of the format:
An ASSEMBLY Program for the TI-84+/SE
I put that on the same lines as the name of the program but right after it's little box, it looks good.
So anyone have anymore things to add to either "Programmed For:" or "Program Type:" ?
Oh and I use the / to indicate it's basically compatible for both, so I can put TI-89/+ right? Also, do you think can I include TI-83 in TI-83+/SE? So in other words it would be TI-83/+/SE. |
Vectris
Ultralisk
Posted: 17 Oct 2008
05:43 GMT
Total Posts: 375 | Update
Added Save To button and directory text to let you choose where to create the file.
(by default it's the desktop)
Updated Screenshot to show new design.
Added custom Icon (it's the icon for a .8xp file and a .txt file behind it, hard to see in the screenshot).
Re-named to Manual Generator.
Put current progress in first post, I have gotten pretty far now.
I am currently looking for better ideas for a name. I was thinking Documentation Generator but that sounds to formal. I changed it from Manual Maker because it sounds a little to informal. Manual Generator is good for now, but if anyone has suggestions post them and perhaps I can come up with something better. |
me2
Goliath
Posted: 20 Oct 2008
11:52 GMT
Total Posts: 171 | Sorry. You can't have TI-83/+/SE. They have to be separate. The 83+ is different, as it has slightly different coding, no archive, and more RAM. The TI-89 and TI-89 Titanium (or TI-89 Ti)are different, as some programs have compatability issues and need to be ghostbusted if they are put on a Titanium. Otherwise, it looks good. I might add, though, that you shold add the program type 'Computer Application' to your list to distinguish it from a calc application. Also, you could combine Windows 95 and 98 as they are pretty much the same.
---
<--- Going out with a bang. |
Vectris
Ultralisk
Posted: 20 Oct 2008
15:18 GMT
Total Posts: 375 | K thanks a lot for checking, but my list up above has the TI-83 and 89 corrections already. As for the computer App, it won't be confused for a calculator one because the programmed for will answer it.
An Application for Windows XP
An Application for the TI-83
They both make sense.
About the 83, I can keep TI-83+/SE though right? I just need the plain TI-83 separate. |
tifreak8x
Administrator
Posted: 21 Oct 2008
07:32 GMT
Total Posts: 419 | me2... get your fact straight there. The 83 is the one without Archive and more RAM, the 83+ has an archive.
---
Bringing you Pokemon, for your calculator. |
me2
Goliath
Posted: 23 Oct 2008
11:23 GMT
Total Posts: 171 | Sorry, TIfreak, I knew that, I just was in a big hurry when I made that post. To haveacalc's question, yes, that's fine. A TI-83+ program is compatable with the 83+SE, and 84+/SE. For a name, how about Readme Writer or Quicktext?
---
<--- Going out with a bang. |
Vectris
Ultralisk
Posted: 25 Oct 2008
17:00 GMT
Total Posts: 375 | me2 I like Readme Writer, if I used it would you want specific credits? Would you be fine with just "Special Thanks to members of www.calcg.org" in the about button pop up? I'd prefer not to name specific people.
In other news...
Updates
-Finished the ZIP File information part, it was the longest and hardest, should be easier from here on out.
-Finally finished revision of the programmed for and prog type options (wasn't sure what to do if you only selected one, I finally got it to just leave it blank, not the best idea but before it gave errors when left blank).
Perhaps a couple more weeks and I'll enter the beta testing stage.
|
BrandonW
Goliath
Posted: 27 Oct 2008
06:33 GMT
Total Posts: 100 | Why would you prefer not to name specific people?
|
me2
Goliath
Posted: 27 Oct 2008
10:29 GMT
Total Posts: 171 | I don't care, you could just say 'Name courtesy of me2labs' or something like that, I don't care if you don't even want that, or if you want to put my name, that's fine too. Whatever you like, do it. It's your program.
---
<--- Going out with a bang. |
Vectris
Ultralisk
Posted: 27 Oct 2008
14:44 GMT
Total Posts: 375 | @me2 good, I just had to make sure you weren't one of those stuck up people obsessed with being cited. Glad to see your cool ;)
@brandonW while I have done all the work myself, I have still received input from like 4 members already on CalcG, not to mention future beta testers from here and possibly other forums and people in real life. If I name specific people it will go from being a simple about button to a complete Credits section, this is meant to be a simple app.
Perhaps I can cite specific people but I need a credits section, any idea on how I would add that to something small and simple like this? I don't like the idea of having a Credits button.
EDIT: Hmm, the more I think about it the more I change my mind. Give me some time, I may just make the About button give you a list of the credits, after all part of About the program is who helped to make it I suppose.
|
Zachary940
Wraith
Posted: 27 Oct 2008
14:56 GMT
Total Posts: 714 | I think you should make an about button. Give general info about the program, such as the version number and so on, as well as your name and whatever else you want.
If you need a tester just let me know.
EDIT: Wow i did not see your edit, to be honest I do not even think it was there.
---
It is much easier to suggest solutions when you know nothing about the problem. |
Vectris
Ultralisk
Posted: 27 Oct 2008
19:35 GMT
Total Posts: 375 | That's fine, it's good to have my same thoughts confirmed by someone else. And thanks for offering to test, I want to get as many of you at calcg to test it as possible, to make sure it's perfect before the release.
Just off-hand, does anyone else here program in VB? |
Vectris
Ultralisk
Posted: 28 Oct 2008
13:52 GMT
Total Posts: 375 | Arg I just ran into a problem. I didn't think to realize that everyone's notepad might have a different font size, it's also possible that it could have a different font type and that would really screw it up, but like 99% of computers I've used have had it at Lucida Console, the only problem is resolution and font size.
Since all of the first ASCII graphics are just boxes, they work regardless of size, but for the last one, the table of contents and chapter titles, I have the lines span the width of the page.
How many of you can view the sample .txt and see that the lines for the table of contents and chapter titles span the whole page?
I can't think of any way to fix this other than having it fall short/long for some people or to convert them to boxes, which wouldn't really look good. |
john777
Ultralisk
Posted: 29 Oct 2008
16:46 GMT
Total Posts: 289 | I can do you need an e-mail or something. |
Vectris
Ultralisk
Posted: 29 Oct 2008
19:50 GMT
Total Posts: 375 | What did you mean by that...
I just need to know, how many of you can see the boxes fit the text in the sample work perfectly and also see that the ----- and ===== span the whole page for the chapters.
I'm not talking about using my program right now, I'm talking about the .txt I'm making it output, which is the sample one for download. |
Zachary940
Wraith
Posted: 30 Oct 2008
07:34 GMT
Total Posts: 714 | As long as word wrap is off, everything looks fine. Even when word wrap is on, it does not look that bad.
I think he means that he is available for testing.
---
It is much easier to suggest solutions when you know nothing about the problem. |
Vectris
Ultralisk
Posted: 30 Oct 2008
14:17 GMT
Total Posts: 375 | I know word wrap doesn't really matter, and the boxes will always be right regardless of size, as long as the font type is the same.
What I'm talking about are the
------------------------
1. Chapter
------------------------
Those are supposed to span the whole page, but on a computer with a higher resolution (or lower) than mine (1024x768) it spans less or more than the whole page, which isn't what I wanted.
I think I'll just add a sentence at the top of the manual stating it is best viewed with Lucida Console size 12 etc. |
john777
Ultralisk
Posted: 30 Oct 2008
20:54 GMT
Total Posts: 289 | Yeah I was just saying I was available to view it or test it if you wanted. I missed the download up at the top though so sorry. For me it doesn't span the whole page. but goes a certain distance, and if word wrap is on, it wraps if I make the window smaller. Maybe it creates it to fit the settings for word pad at the time you create it(if that makes sense). Sorry for the confusion earlier. |
Vectris
Ultralisk
Posted: 31 Oct 2008
20:03 GMT
Total Posts: 375 | It's ok, I figured out the notepad thing.
By default Notepad has Lucida Console font, size 12, and no styling. I keep my notepad at those settings and most computer users never change them, so that's what they are. Also I'm guessing that you haven't changed which default program you use to open .txts, it should still be notepad.
If the person viewing the manual has the same font stuff as above, then it will look fine, the boxes will look nice and the only possible thing that can be off is the === spans, which are affected by resolution. I keep my resolution at the most common, 1024 x 768, well I think it's really common. Anyways any higher and the spans just fall a little short, if the res is lower though, the spans will word wrap or go off the page, even if the windows maximized.
Anyways, thus said, I decided to leave stuff as it is except I added a notice at the top stating the best viewing properties for notepad, the only thing I left unsaid was resolution, but since the res only affects the spans, I decided to leave it out as it's very minor.
In other news...
I've Finished!!!!
Yes, I have finally finished ReadMe Writer!!! I will conduct a couple of tests for a few more days, and if nothing major comes up, I will ask for testers, anyone can help with testing so don't be shy.
Check the first post as I changed the layout majorly.
Oh, and I spent like 10 edits trying to figure out how to increase the size of "I've Finished", I tried all the HTML tags I know, does anyone know how to do it? |
allynfolksjr
Administrator
Posted: 31 Oct 2008
21:22 GMT
Total Posts: 1892 | Awesome! |
