< Importing XML comments : Preview comments? >
|
Ben |
Created: May 25, 2009 09:48 Any thoughts on the Help wiki?As you can see, this is starting to grow into a useful resource. A recent addition is the Injader Reference Guide, which is some way from completion, but will be useful as a guide to all the screens in the Control Panel. The guides will change as the system develops (and especially as we approach Injader 3) but it's a good idea to get the basics down now. Long-term I'd like to add some more task-based documentation, i.e. "how do I"-style guides. Are there any guides you'd like to see first? Tags: None. |
|
ginkgo100 |
1
Created: June 21, 2009 17:21
I know I'm responding to an old thread, but I guess better late than never, eh?
I think a more in-depth explanation of the functions used in themes would be helpful. Also, I think the list needs to be updated; haven't you added some functions that haven't been added to the wiki yet? And how are functions defined, and how does that relate to the MySQL database? I know there's a page called "Writing SQL for Injader," but it's confusing to me; why is there an example given that won't work? * What columns are in the existing MySQL tables? I remember having to use some of the files (I think in the /db folder) as a "cheat sheet" when I experimented with creating plugins. A reference page for this topic would be useful. I think it would be very helpful for beginners (ahem, like me) who are learning how to use code as they go. It would be great if there were links in the appropriate places to tutorials (perhaps the ones from W3 Schools) for people who are not sure, for example, what objects are, or how a MySQL table is set up. As for the variables used in the default theme, an explanation of those would be helpful too, including the naming conventions. I figured out on my own that variable prefixes have important meanings (e.g. str for a string, int for a number/integer). Other questions that need to be answered: * What can user-defined variables be used for? * Which variable definitions from the default theme should we NOT mess with (if any), and which can we tinker with? I know in the themes I've written, I have created my own layout html from scratch, but I use a lot of your php code from the default theme. Tutorial ideas: * To promote Injader to WP users, you could add a WP Import tutorial. Although it looks like a straightforward process, I imagine many potential "converts" might be leary and would benefit from some hand-holding. * How access and permissions are managed from the CP. * A very basic tutorial walking new users through the entire admin CP. Hope these ideas help. |
|
Ben |
2
Created: June 22, 2009 11:14
Thanks for all the comments!
1. To answer some questions: a. How are functions defined - have a read of the Functions guide in the PHP Manual. b. How does that relate to the MySQL database - could you be more specific, please? An example would be good, if you've seen code that you don't understand, or part of the help wiki that needs explaining further. c. What are objects - here's a guide to objects in PHP4. That might be a good starting point. d. How a MySQL table is set up - MySQL INSERT table syntax may be of interest. I think quite a few of your database-related questions will be answered if you try accessing phpMyAdmin from within cPanel (this isn't part of Injader but will allow you to look at the Injader database). e. Which variable definitions should/should not be changed - this will be easier to explain once the theme function reference is complete. 2. Some changes to help you on your wiki: a. Theme Function Reference - updated to include all recent additions. b. Writing SQL for Injader - used an example that will work. c. Theme Development - added a couple of useful links. d. Theme coding conventions - added some prefixes to the bottom. 3. Still to do: a. Explanations for all of the theme functions b. SQL database table structure c. User-defined variables tutorial (this might have to wait until one of the next releases, as they are changing slightly) d. WP import tutorial e. Permissions tutorial f. Control Panel tutorial Still quite a bit to do, but your ideas have definitely helped. It would be good to know if these changes have solved some of your problems. |
|
Ben |
3
Created: June 22, 2009 13:16
OK, I've added some of the theme function pages, which should be a good starting point.
|
|
Ben |
4
Created: June 22, 2009 15:40
Just added: Injader Database Guide.
|
You do not have access to post comments in this area.