HTML Logo by World Wide Web Consortium (www.w3.org). Click to learn more about our commitment to accessibility and standards.

Moving forward with Composr

ocPortal has been relaunched as Composr CMS, which is now in beta. ocPortal 9 will be superseded by Composr 10.

Head over to compo.sr for our new site, and to our migration roadmap. Existing ocPortal member accounts have been mirrored.


ocPortal 4 Code Book

Login / Search

 [ Join | More ]
 Add topic 
Posted
Rating:
#40042 (In Topic #8953)
Avatar

Hello,

For version 4 we're replacing our old dev-guide documentation with our new 'Code Book'. This is literally designed to read as a book, and our ultimate goal with this document is to lay out ocPortal development so that any PHP/web developer can get the highest level of insight from the minimal effort of time investment.

This is a document we intend to refine - I intend to commission other developers to refine it, and I intend to keep adding to it myself. I wanted to post the first draft right away though because it's already a whole lot better and more up-to-date than the dev-guide was.
(attachment removed - see later post for newer version)
Apart from the new content and format, the biggest change is that the old API documentation is no longer present in the guide itself. I figured that this is pretty pointless as it's all in the ocPortal source code anyway.

This is a book aimed at developers so it quite likely won't make a lot of sense to everybody. Rest assured that we do have plans to improve our webmaster documentation as well.


Last edit: by Chris Graham


Become a fan of ocPortal on Facebook or add me as a friend. Add me on on Twitter.
Was I helpful?
  • If not, please let us know how we can do better (please try and propose any bigger ideas in such a way that they are fundable and scalable).
  • If so, please let others know about ocPortal whenever you see the opportunity.
  • If my reply is too Vulcan or expressed too much in business-strategy terms, and not particularly personal, I apologise. As a company & project maintainer, time is very limited to me, so usually when I write a reply I try and make it generic advice to all readers. I'm also naturally a joined-up thinker, so I always express my thoughts in combined business and technical terms. I recognise not everyone likes that, don't let my Vulcan-thinking stop you enjoying ocPortal on fun personal projects.
  • If my response can inspire a community tutorial, that's a great way of giving back to the project as a user.
Back to the top
 
Posted
Rating:
#40051
Avatar

Community saint

I am reading it now.
So far it looks good, nothing beyond my head yet.  :thumbs:

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40056
Avatar

Community saint

Waaaay beyond mine!

But — it is just possible that specific 'wants' might be answered before I'm tempted to ask publicly …

 O_o

Take my advice. I'm not using it!

View my working ocPortal site (version 9.x.x) at Anglo-Indian Portal
Back to the top
 
Posted
Rating:
#40057
Avatar

Community saint

Fletch said

Waaaay beyond mine!

But – it is just possible that specific 'wants' might be answered before I'm tempted to ask publicly …

 O_o
  Aww, I thought you were beyond me.
Well you do have a good site and have done the updates manually which impresses me.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40066
Avatar

Community saint

This is a fun read, I can not think of any thing to add but will try and think of some later and then if I think of some thing I will let you know.

Keep up the good work.  :thumbs:

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40473
Avatar

Here's the final version of the document, for ocPortal version 4.

Attachment
» Download: codebook4.pdf (885 Kb, 1275 downloads so far)


Become a fan of ocPortal on Facebook or add me as a friend. Add me on on Twitter.
Was I helpful?
  • If not, please let us know how we can do better (please try and propose any bigger ideas in such a way that they are fundable and scalable).
  • If so, please let others know about ocPortal whenever you see the opportunity.
  • If my reply is too Vulcan or expressed too much in business-strategy terms, and not particularly personal, I apologise. As a company & project maintainer, time is very limited to me, so usually when I write a reply I try and make it generic advice to all readers. I'm also naturally a joined-up thinker, so I always express my thoughts in combined business and technical terms. I recognise not everyone likes that, don't let my Vulcan-thinking stop you enjoying ocPortal on fun personal projects.
  • If my response can inspire a community tutorial, that's a great way of giving back to the project as a user.
Back to the top
 
Posted
Rating:
#40475
Avatar

Community saint

ok thanks. I will read it later.

I run http://otakuplayground.com and am hopping to make themes and other things for ocportal even though I no longer use it for otakuplayground.com I still love it and feel it could go far with the right help. It needs themes and needs people to advertise for it.
Back to the top
 
Posted
Rating:
#40746
Avatar

We now also have API documentation.


Become a fan of ocPortal on Facebook or add me as a friend. Add me on on Twitter.
Was I helpful?
  • If not, please let us know how we can do better (please try and propose any bigger ideas in such a way that they are fundable and scalable).
  • If so, please let others know about ocPortal whenever you see the opportunity.
  • If my reply is too Vulcan or expressed too much in business-strategy terms, and not particularly personal, I apologise. As a company & project maintainer, time is very limited to me, so usually when I write a reply I try and make it generic advice to all readers. I'm also naturally a joined-up thinker, so I always express my thoughts in combined business and technical terms. I recognise not everyone likes that, don't let my Vulcan-thinking stop you enjoying ocPortal on fun personal projects.
  • If my response can inspire a community tutorial, that's a great way of giving back to the project as a user.
Back to the top
 
Posted
Rating:
#54171
Avatar

Fan in training

Hi Chris,

First and foremost ocportal is just great. Thanks for your entire team for making such fantastic product.

Is it possible for you guys to publish the documentation for users in a way it goes chapter by chapter and increasing the complexity? That would just be very useful because now I have to keep looking for topics on the tutorial page of the website.

for e.g.

  1. What ocportal is and what to expect from it?
  2. installlation and configuration
  3. Themes
  4. Zones etc etc.
This would greatly help all the users like me to start right away. :)

It will be a single file (a pdf) containing all the chapters.

Thank you so much,
Atul
India
Back to the top
 
1 guests and 0 members have just viewed this: None
Control functions:

Quick reply   Contract

Your name:
Your message: