 Notice. New forum software under development. It's going to miss a few functions and look a bit ugly for a while, but I'm working on it full time now as the old forum was too unstable. Couple days, all good. If you notice any issues, please contact me. |
Forum Index : Microcontroller and PC projects : Doc Register ideas
| Author | Message | ||||
Gizmo Admin Group  Joined: 05/06/2004 Location: AustraliaPosts: 5129 |
Hey guys. Finally got around to building a document register for the site. The doc register is a place where code, info, files, etc can be shared with anyone. Say for example you have developed some routines for a Micromite to display pie charts on a LCD screen, or a circuit to regulate the heating of your hen house, or a arduino powered retro games console, and you want to share it with everyone, then the doc register can be used in combination with the forum to store your project files and info. The doc register ( for want of a better name ) is for stuff that works, not projects in development or untested. The register is searchable, and can display docs by author, keywords, date, etc. You can link to any doc, as each doc is given a unique id number. Each record contains the following info... - Title, Intro and Description texts. - A version number, in case you want to release a new version and keep the old version online. - Authors name, and optionally the authors email and web site. - A uploaded file ( ZIP, PDF, GIF, JPG or PNG ) - Date it was uploaded, how many people have viewed it, and last viewed at. - Generic keywords, eg hardware,picaxe,software,circuit,GPS,LCD,etc - User added keywords, eg SSD1963,NE555,Dump Load,RS232 Generic keywords are preset options, you tick the ones that apply to your project, for example if its a piece of PicAxe code to talk to a GPS module, you may tick picaxe, software, GPS. User added keywords are words like part numbers, like a GPS module model number. The Generic and User keywords will make it easy to search for documents. What I need help with is the generic keywords. I have the following, what else should we add or remove. Hardware, Circuit, Software, Microcontroller, PicAxe, Maximite, Micromite, Arduino, GPS, LCD, Solar, Wind, CNC, Stepper, Servo, Power Supply, Measurement. Glenn The best time to plant a tree was twenty years ago, the second best time is right now. JAQ |
||||
Geoffg Guru  Joined: 06/06/2011 Location: AustraliaPosts: 3303 |
That sounds brilliant. It it up yet? I went searching for it but could not find it. Geoff Geoff Graham - http://geoffg.net |
||||
| Gizmo Admin Group Joined: 05/06/2004 Location: AustraliaPosts: 5129 |
Not yet Geoff, over the weekend. I plan to have a few administrators, like yourself and a few other contributors, and whoever you nominate. Administrators can add new docs, and edit the ones they added. So if someone has a bit of code or whatever you consider needs to be saved in the register, you can add it for them, and put them down as the author. Will send you a link via email once its online so you can have a look. Glenn The best time to plant a tree was twenty years ago, the second best time is right now. JAQ |
||||
| isochronic Guru Joined: 21/01/2012 Location: AustraliaPosts: 689 |
I hope the document number is fixed ? Eg if someone changes their document, I hope the changed document gets a new document number ? Otherwise changes can be made that may be unnoticed 
Also, if hex files are to be included, a checksum should be compulsory. Good ! Good ! 
PS - 'Text' should be added as a keyword, ie as opposed to schematic, source, hex etc |
||||
| Gizmo Admin Group Joined: 05/06/2004 Location: AustraliaPosts: 5129 |
Doc id is fixed. If you change the docs details, the doc id is unchanged. If you wanted to add a new version and leave the old version in place, you create a new record. Hex files etc would be zipped. No checksum. The docs description is just plain text, not meant for code. Any code should be in the zip file. Glenn The best time to plant a tree was twenty years ago, the second best time is right now. JAQ |
||||
MicroBlocks Guru Joined: 12/05/2012 Location: ThailandPosts: 2209 |
Maybe the 'plain text' could be HTML. If you are using trusted members only then it does not have any security problems. HTML will provide some layout and embedding of pictures. As it is pure text anyway storing it is not any different. Microblocks. Build with logic. |
||||
| Gizmo Admin Group Joined: 05/06/2004 Location: AustraliaPosts: 5129 |
If the editor included html in the description, then it would(should) display correctly. At the moment it just handles a simple carriage return, replacing it with a <br/> tag. The idea is most of the information is stored in the uploaded file, the doc register is no more than a system to index the uploaded files, so you can find the file you want. Think of it like a index card in a old school library, you use the index cards to find the book you want, the book itself has all the information is it. Glenn The best time to plant a tree was twenty years ago, the second best time is right now. JAQ |
||||
lew247 Guru Joined: 23/12/2015 Location: United KingdomPosts: 1702 |
Brilliant idea Thanks  |
||||
kiiid Guru Joined: 11/05/2013 Location: United KingdomPosts: 671 |
Excellent! waiting to see it happening http://rittle.org -------------- |
||||
Grogster Admin Group Joined: 31/12/2012 Location: New ZealandPosts: 9641 |
Nice one!
Can't wait to look at it. I hope that matherp elects to save all his Cfunction code within this new feature, as it would make searching for specific Cfunctions much easier. Smoke makes things work. When the smoke gets out, it stops! |
||||
| MicroBlocks Guru Joined: 12/05/2012 Location: ThailandPosts: 2209 |
Ah, got it. That would work pretty good! Microblocks. Build with logic. |
||||
| robert.rozee Guru Joined: 31/12/2012 Location: New ZealandPosts: 2447 |
i trust .exe files can be uploaded within a .zip file? it may also be useful to allow several documents to be attached to one 'index card'. an example being in the case of an index card titled "HC-12 wireless" where there could be a .pdf (datasheet) and a .exe (config utility). having provision for a standard sized picture (say 200 x 200 pixels) on each index card would be nice, for a screenshot, image of the item described, etc. perhaps also a set of 'standard' images that can be used if none is uploaded. i have a few bits and pieces i'd be happy to upload. some other possible keywords: test equipment, datasheet, custom function, analog, photography cheers, rob :-) |
||||
| isochronic Guru Joined: 21/01/2012 Location: AustraliaPosts: 689 |
If someone edits a file, is there any indication that the file changed ? You don't want the situation where someone edits.. and edits...again... and again... leaving the initial readers/users in limbo. Also there should be definition of "stuff that works", ie what is the acceptance based on ? a simple no-beta rule would be too optimistic |
||||
bigmik Guru Joined: 20/06/2011 Location: AustraliaPosts: 2956 |
Hi Glenn, That is a great idea.. I am happy if you want me to add all of the manuals for my boards there but I do want to keep control of the editing process. So I would prefer them to be not editable by anyone but myself and a `moderator'. I have no problems with people adding other relevant documentation if they see fit but the manuals, and their editing, needs to be controlled. Kind Regards, Mick Mick's uMite Stuff can be found >>> HERE (Kindly hosted by Dontronics) <<< |
||||
| Gizmo Admin Group Joined: 05/06/2004 Location: AustraliaPosts: 5129 |
Chronic its up to the editors to track version numbers. They can either copy an existing record, change the version number and description and upload a new file, or just change the version number on an existing record and upload the new file, The 2nd option would happen if the old file had a serious bug. The "stuff that works" is a way to keep the register uncluttered and relevant. So untested code or circuits, idea's, etc, are not going into the register. Mick only the original editor can make changes to their records. So if you were to put your manuals into the register, no other editor else could make changes. Glenn The best time to plant a tree was twenty years ago, the second best time is right now. JAQ |
||||
 Print this page |
 |
The Back Shed's forum code is written, and hosted, in Australia. | © JAQ Software 2025 |
