Structure suggestion

Discussion of the documentation project.
nils73
Power Poster
Power Poster
Posts: 520
Joined: Wed Sep 08, 2004 3:32 pm

Structure suggestion

Post by nils73 »

1. What is CMS made simple and when should I use it?
1.1 What it is
1.2 What it isn't
1.3 Architecture of CMS made simple
1.3.1 Dynamic Content Creation
1.3.2 Cached Content
1.4 Use Cases (CMS, Blog, Intranet, etc.)


2. Getting things started
2.1 Requirements
2.1.1 Windows
2.1.2 Linux, Unix, FreeBSD, etc.
2.1.3 Mac OS X
2.2 Installing CMSMS
2.2.1 Last Check before Take-Off (Apache, MySQL, etc.)
2.2.2 Wizard Step by Step Guide
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 Problems & Troubleshooting
2.2.4 Successfully installed - what now?
2.3 First Login (as admin)


3. Basic Use
3.1 Logging in
3.2 Overview (Pages, Template, etc.)
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 a page?
3.4.2 modify a page?
3.4.3 delete a page?
3.4.4 create a news-item?
3.4.5 modify a news-item?
3.4.6 delete a news-item?
3.4.7 upload an image?
3.4.8 upload a file?
3.4.9 add a user?
3.4.10 modify a user?
3.4.11 delete a user?
3.4.12 add a user-group?
3.4.13 modify a user-group?
3.4.14 delete a user-group?
3.4.15 assign user-rights to user-groups?
3.4.16 assign users to user-groups?
3.5 Using HTML-Blobs
3.5.1 What is a Blob?
3.5.2 Creating a Blob
3.5.3 Modifying a Blob
3.5.4 Deleting a Blob
3.6 WYSIWYG Editor (by default TinyMCE)
3.6.1 Type text
3.6.2 Format text
3.6.3 Insert an image
3.6.4 Create a link


4. Advanced Use
4.1 Templates
4.1.1 Basic Layout
4.1.2 News Layout
4.1.3 Other Templates (Archive, Front-Page, etc.)
4.1.4 Using Smarty
4.1.4.1 Variables in CMSMS
4.1.4.2 Pure Smarty
4.2 Stylesheets
4.2.1 Managing styles (CSS)
4.2.1.1 Create a new Stylesheet
4.2.1.2 Modify an existing Stylesheet
4.2.1.3 Delete a Stylesheet
4.3 Adding modules
4.3.1 Types of modules
4.3.2 Getting modules
4.3.3 Uploading modules
4.3.4 Installing a module
4.3.5 Enabling a module
4.3.6 Disabling a module
4.3.7 Deleting a module
4.4 Using Tags
4.4.1 Adding a Tag
4.4.2 Deleting a Tag
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 Using User-defined Tags
4.5.1 Adding a User-defined Tag
4.5.2 Deleting a User-defined Tag
4.6 Preferences
4.6.1 Using WYSIWYG
4.6.2 Language seetings
4.6.3 Using Themes
4.6.4 Using Admin-Bookmarks
4.6.5 Using "Recently Used Pages"
4.7 Site Admin
4.7.1 Preferences
4.7.1.1 Clearing the Cache
4.7.1.2 Custom 404
4.7.1.3 Site Down Message
4.7.1.4 Global Admin Theme
4.7.2 Admin Log
4.7.2.1 Reading the Admin Log
4.7.2.2 Deleting the Admin Log


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


6. Support & Help
6.1 Basic questions & FAQ
6.2 Support forum / Community
6.2.1 Support policy
6.2.2 How do I best write a question?
6.2.3 How do I answer a question?
6.3 Consulting & Paid Support
Last edited by nils73 on Mon Jun 27, 2005 8:07 pm, edited 1 time in total.
piratos

Re: Structure suggestion

Post by piratos »

This structure nearly looks like my german handbook, that was never finished, because each day something new comes.
nils73
Power Poster
Power Poster
Posts: 520
Joined: Wed Sep 08, 2004 3:32 pm

Re: Structure suggestion

Post by nils73 »

I wonder if this means that it is okay ...
piratos wrote:This structure nearly looks like my german handbook
... and I even wonder, if you could have come up with the German version of the structure beforehand. Well, let's see what others say then.

Regards,
Nils
miketmc

Re: Structure suggestion

Post by miketmc »

I think the structure ist OK;
with the first view, there is nothing missing
Ted
Power Poster
Power Poster
Posts: 3329
Joined: Fri Jun 11, 2004 6:58 pm
Location: Fairless Hills, Pa USA

Re: Structure suggestion

Post by Ted »

That structure looks great to me.  It's a very logical progression from beginning to end.
piratos

Re: Structure suggestion

Post by piratos »

and I even wonder, if you could have come up with the German version of the structure beforehand
I'm writing my handbook since the first 0.10 version . Take a look on other handbooks - the structure is most the same.
nils73
Power Poster
Power Poster
Posts: 520
Joined: Wed Sep 08, 2004 3:32 pm

Re: Structure suggestion

Post by nils73 »

I am not quite satisfied with the structure, mainly because it is not suitable for navigation purpose. We should come up with a navigation structure as well ... and by the way: I would prefer not to use the layermenu and instead favor the bulletmenu. Any ideas on how to proceed with a navigation that uses up less space and is still usable?

Here is an example of what I mean:

1. What is CMS made simple and when should I use it?

could be

About

but it might also be something else. I am not quite sure here and the whole sentence is definitely too long for a navigation.

Regards,
Nils
piratos

Re: Structure suggestion

Post by piratos »

There are some other questions:
  • Word - Processor ?
  • Format of the document (Word.doc, TXT, PDF, HTML , CHM or so on
My handbook was a Word - Doc (Office XP) , but i deliver it only as Adobe PDF 5.0.

With the decision of the format you must see the version of it, a.e. doc as Office XP or OpenOffice and the version of the program, PDF Version 5.0 or the latest, HTML - HTML 4.01 or XHTML or whatever, CHM can only be a format for windows-user , not all linux - systems can read this without problems.

And then the layout of the document itself. And last but not least you must split the work to several people and you need a supervisor.
Ted
Power Poster
Power Poster
Posts: 3329
Joined: Fri Jun 11, 2004 6:58 pm
Location: Fairless Hills, Pa USA

Re: Structure suggestion

Post by Ted »

If possible, I would like to do docbook or at least some form of text markup.  It's cross platform, portable and can be saved into the svn repository.  It can also easily be merged if several people are working on different parts.  I've never done docbook before, but I'd be willing to help with the research to find a nice editor for people to use to aid in the process.
piratos

Re: Structure suggestion

Post by piratos »

Docbook ? Not with me, too complicated for this relativ small projekt.
Ted
Power Poster
Power Poster
Posts: 3329
Joined: Fri Jun 11, 2004 6:58 pm
Location: Fairless Hills, Pa USA

Re: Structure suggestion

Post by Ted »

Playing more and more with this idea...

http://www.xmlmind.com/xmleditor/stdedition.html

I mocked up 2 chapters and exported it to html in about 5 min.  Can do PDF with the professional version, but there are also other converters out there to do it.  I would make sure that I know how to do it if it was necessary.

Thoughts?
piratos

Re: Structure suggestion

Post by piratos »

You mean the free personal edition.
I will test it tomorrow.

Other Editors have a price from 170 $ until 500 $.
Ted
Power Poster
Power Poster
Posts: 3329
Joined: Fri Jun 11, 2004 6:58 pm
Location: Fairless Hills, Pa USA

Re: Structure suggestion

Post by Ted »

Yeah, I agree.  We should really do it if there is a free version...  Granted you could just edit the xml, but who wants to do that?
piratos

Re: Structure suggestion

Post by piratos »

Granted you could just edit the xml, but who wants to do that?

That is the question !
Can do PDF with the professional version, but there are also other converters out there to do it
If you have the complete adobe it is no problem. You can open HTML and print it as PDF, or you can open a Website and print it as pdf and so on.
piratos

Re: Structure suggestion

Post by 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.
Locked

Return to “[locked] Documentation0ld”