Structure suggestion

[piratos]

Another idea.

Use your own cms to produce handbooks.

1. make a subdomain handbook.cmsmadesimple or handebook_en
2. make blank contents as the structure is
3. attach users with  modify rights for each capital

4. write a little exportscript so that yout get only the xhtml-pages within the structure as one xhtml-page

5.print it with adobe as pdf to deliver the handbook with the download

So everbody can look the handbook as it grows and everbody who is interesting to do something for this cms can it do.

[nils73]

Use your own cms to produce handbooks.

Guess what we are about to do ...

1. make a subdomain handbook.cmsmadesimple or handebook_en

It is http://docs.cmsmadesimple.org. Potential authors can be added as users -- just let me know.

2. make blank contents as the structure is

After we have a navigation structure ...

4. write a little exportscript so that yout get only the xhtml-pages within the structure as one xhtml-page

The website will be as lean and mean as possible in XHTML. Then we can easily import it into OpenOffice Writer. From there it is only a small step to

a) DocBook (OpenOffice takes care of it)
b) PDF (hey, there is a tagged output for free)
c) any other text-format or even flash, if neccessary.

OpenOffice probably lacks some features and DocBook isn't supported to its full extent but it should be sufficient for our documentation project. However, it is still some way to go. We will have to assign tasks like writing stuff, lecturing it and having someone at least who will transform all of this into one corporate writing with the same tonality (i.e. formal vs. informal, explicit vs. bullets).

But as said before: we need a navigation structure beforehand.

Regards,
Nils

5.print it with adobe as pdf to deliver the handbook with the download

So everbody can look the handbook as it grows and everbody who is interesting to do something for this cms can it do.

[Ted]

Sounds like you have it under control.    Unless something weird happens, we'll do that.  If it proves to not work out well, then we can come up with an alternate plan.

[Alex_Leipzig]

Count me in as well - can I get access, too?
The structure seems pretty perfect to me.

[nils73]

Since nobody came up with a navigation structure (you really didn't want something like "What CMS made simple is" as a menu text, did you?), I have tried to create one on my own but my English isn't at its best so I would like you guys to have a look at it and compare it to the content structure (still the same though) and see if it's as self-explanatory as possible. Input is welcome.

If we can settle on this one or something similar within the next few days I will set up this structure at http://docs.cmsmadesimple.org/ and assign the first users who volunteered to help.

1. About
1.1 What it is
1.2 What it is not
1.3 Architecture
1.3.1 Dynamic Content
1.3.2 Cached Content
1.4 Use Cases


2. Install & Run
2.1 Requirements
2.1.1 Windows
2.1.2 Linux
2.1.3 Mac OS X
2.2 Installation
2.2.1 Last Check
2.2.2 Installation Wizard
2.2.2.1 Step 1
2.2.2.2 Step 2
2.2.2.3 Step 3
2.2.2.4 Step 4 ...
2.2.3 Troubleshooting
2.2.4 What now?
2.3 First Login


3. Basic Use
3.1 Logging in
3.2 Overview
3.3 Where do I get ...
3.3.1 a working template?
3.3.2 additional plug-ins?
3.3.3 tags?
3.3.4 user-tags?
3.3.5 help?
3.4 How do I ...
3.4.1 create pages?
3.4.2 modify pages?
3.4.3 delete pages?
3.4.4 create news?
3.4.5 modify news?
3.4.6 delete news?
3.4.7 upload images?
3.4.8 upload files?
3.4.9 add users?
3.4.10 modify users?
3.4.11 delete users?
3.4.12 add user-groups?
3.4.13 modify user-groups?
3.4.14 delete user-groups?
3.4.15 assign user-rights?
3.4.16 assign users?
3.5 HTML-Blobs
3.5.1 What Blobs are
3.5.2 Creating Blobs
3.5.3 Modifying Blobs
3.5.4 Deleting Blobs
3.6 WYSIWYG Editor
3.6.1 Input text
3.6.2 Format text
3.6.3 Insert images
3.6.4 Create links


4. Advanced Use
4.1 Templates
4.1.1 Basic Layout
4.1.2 News Layout
4.1.3 Other Templates
4.1.4 Using Smarty
4.1.4.1 Variables
4.1.4.2 Pure Smarty
4.2 Stylesheets
4.2.1 Managing styles
4.2.1.1 Create
4.2.1.2 Modify
4.2.1.3 Delete
4.3 Modules
4.3.1 Module types
4.3.2 Where to get
4.3.3 Install
4.3.4 Enable
4.3.5 Disable
4.3.6 Delete
4.4 Using Tags
4.4.1 Add
4.4.2 Delete
4.4.3 How do I use ...
4.4.3.1 adsense?
4.4.3.2 breadcrumbs?
4.4.3.3 bulletmenu?
4.4.3.4 cms_module?
4.4.3.5 cms_selflink?
4.4.3.6 cms_version?
4.4.3.7 cms_versionname?
4.4.3.8 contact_form?
4.4.3.9 current_date?
4.4.3.10 dhtmlmenu?
4.4.3.11 footer?
4.4.3.12 googlepr?
4.4.3.13 imagetag?
4.4.3.14 modified_date?
4.4.3.15 print?
4.4.3.16 search?
4.4.3.17 sitemap?
4.4.3.18 startExpandCollapse?
4.4.3.19 stopExpandCollapse?
4.5 User-defined Tags
4.5.1 Add
4.5.2 Delete
4.6 Preferences
4.6.1 Using WYSIWYG
4.6.2 Language
4.6.3 Themes
4.6.4 Admin-Bookmarks
4.6.5 Recently Used Pages
4.7 Site Admin
4.7.1 Preferences
4.7.1.1 Cache
4.7.1.2 Custom 404
4.7.1.3 Site Down Message
4.7.1.4 Admin Theme
4.7.2 Admin Log
4.7.2.1 Read
4.7.2.2 Delete


5. Professional Use
5.1 User-defined Tags
5.2 Tags
5.3 Modules
5.3.1 API
5.3.2 Language
5.3.3 User Help
5.3.4 Upload
5.3.5 Support
5.4 Front-End Themes
5.5 Admin Themes
5.5.1 Templates
5.5.2 Stylesheets
5.5.3 Icons


6. Support & Help
6.1 FAQ
6.2 Forum
6.2.1 Support policy
6.2.2 Asking Questions
6.2.3 Answering
6.3 Consulting


Regards,
Nils

[Alex_Leipzig]

I think that's a good structure. And if we'd want to modify it, we could also do it later, couldn't we?

[nils73]

It's just like building a good solid house. You "could" go and remove walls, add a garage or anything you want. But it would be better to have something solid. Keep in mind that CMSMS competes with commercial Content Management Systems out there. Most of these systems has professional support. We haven't (yet) and it's the same with the documentation. It has to be different and better than the rest. At least this is my personal point of view. But then of course websites are never "final" ...

Okay, enough talk. I would appreciate if someone with better skills in English language would have a look at both structures. Afterwards we could start off with the next step which will be initializing the structure and assigning tasks. I have prepared a document in Rich Text Format to collect the information for each navigation item as one document. These documents could be deposited in the file-section of CMSMS and can be used to transform the website into DocBook format and PDF later on much more easily.

Regards,
Nils

[kishman155]

Why aren't use database and editor like in cmsms.
Implementing a module in cms that calls create help.

This module connects to the help.php at docs.cmsmadesimple.org.
this script takes the information and post it into tables with categoies like nils73 posts.

as i know apache could create pdf´s by his own and and if somebody want a pdf he could click a button
in docs.cmsmadesimple.org so the server creates temporary a pdf of all content in the database.

In this format defelopers could implement helpfunktions based on the kategories in the database to help users
find the right way how they use a module or the contentpage or somthing else.

Code: Select all

createlinkgotohelp($categorie)

like this system there never will be a old pdf.

kris

[nils73]

kishman155, I like the idea of having an interactive help. That is part of the Authoring Tools Accessibility Guidelines (ATAG) and as I have explained in other threads before it would be great to make CMSMS the first Content Management System that conforms to these guidelines. But I am not sure if it would be easy to implement - maybe wishy and others can comment on this.

However, this would only be an add-on to what we are going to do.

Regards,
Nils

[Ted]

I'd have to do some research before I could comment fully on it.  Sounds great, though! 

[askme]

By the way where is the BOOK? When we will get to read... we are beginners.... and book will really help us................ SO LISTEN OUR VOICE!!!!!!!!!!!!!!!!!

[ZYV]

Just a quick note... why would not you use TeX/LaTeX with say Memoir class for the book? It's easy to use, free, open source, lots of free and great editors, fantastic graphic arts quality etc. No problem to store this in SVN as well.