Sometimes, technical documentation can be perfectly accurate, but the facts are not explained in plain English! That's why the following page is written by beginners for beginners, in the way that questions would be asked. __Please note: This documentation is under development. It is not yet as reliable as the ((Documentation|official documentation)).__

The solutions here may not be perfect but will get the result. They may change over time, as the beginners who contribute find a "better" way. Everybody is welcome to contribute, even Experts! (Remember, plain English.) Please note that there is a tab in your installation of Bitweaver, called ''Wiki Help'' where you can find some syntax help.

::{attachment id=922}::

{maketoc}
---
!!!~~red:How do I add a document to a page or a posting?~~

First you need to upload the document to a __Treasury__ gallery: go to __Create Gallery__ in the drop down Treasury menu and the rest is fairly explanatory. Then to put a document into it go to:

__Treasury > Upload File__

Enter a title (this effectively renames the file as this is what shows when you use the file on a page). Description is optional. Choose the gallery it is to go into. Click upload file.

Having done this Bitweaver will have assigned a numerical ID to it. To find out what this is, go to the gallery via the menu bar to __List Galleries__ (or if your installation shows the path, click on the gallery name). Choose the gallery and it will list all the contents. Notice the ID number - this is what you will want to copy and paste to the page you want to use the file in.

This makes a link to the file number 67 appear in the page.

{code}{file id=67}{code}
---
!!! ~~red:How do I add an image to a page or a posting?~~

First you need to upload the image to a __Fisheye__ gallery. Go to __Create Gallery__ in the drop down Fisheye menu and the rest is fairly explanatory. Then, to put an image into the gallery go to:

__Fisheye > Upload Images__

You will see title and description boxes, but may also see that there are options for how to handle the upload - like rotation and resizing.
Choose the gallery it is to go into. Click upload file. Having done this, Bitweaver will have assigned a numerical ID to it. It is displayed underneath the image for you to copy and use in pages or postings.

You can also go to the __Home Page__ drop down menu on the top menu bar to __All available content__ and scroll through to find newly uploaded image, as it is ordered by date. In any case, the code you're looking for looks something similar to:

{code}{attachment id=918}{code}
Pasting this into a page or posting means that the image number 918 will be displayed inline. Any attachment can be displayed like this. For images though there is an added feature - and that is the variable sizing. When you upload an image, Bitweaver processes it into five different sizes and saves the original too:

icon, avatar, small, medium, large, original

Following this standard you can define the image size by:

{code}{attachment id=918 size=icon}{code}
---
!!!~~red:How do I add my own HTML code to a box/widget?~~

Go to __Admin > Themes > Custom modules__. Give it a name (reference only), a title (that appears on the site) and enter your code (HTML or Javascript). Preview and save.

Click on the ''assign'' icon (paperclip) down the bottom of that same page to jump to the Layout page to place the box/widget/module where you want it.
---
!!!~~red:How do I allow users to send messages to each other?~~

This package must be 'checked' in __Admin>Kernel>Packages__ (see both installed and uninstalled tabs).

Then the permissions need to be set for who is allowed to send messages to each other.

__Admin>Users>Permissions Maintenance__
---
!!!~~red:How do I block people (registered users) from seeing menu's and assign permissions?~~

What I did was to edit one of the groups that have already been assigned permissions (the ability to do or see certain things on the site) so that they could see the items in the menu bar that I wanted to be public, but if they were not admin, they couldn't see 'my' menu (more on that later).

To do this go to __Kernel>Users>Groups & Permissions__ and you will see what permissions are the default.

What I did was change the registered users group, by clicking on the edit icon in the top right section of the page where registered users list is, and going to the __Assign Permissions__ tab.

I striped most things out, as I am rolling out the site in stages. So I launched the forums (installed phpbb) first. Then the wiki/image galleries/file galleries will come next, along with newsletters, rss etc.

At each stage I can change the permissions for the registered users group - adding more as I choose.

Now about the admin menu. I used the nexus package to make a totally separate menu from the one that is displayed to the registered users (or the anonymous group).

This is not so intuitive, but I will try to explain.

Go to the __Admin menu>Nexus__ and slide across to __Nexus menu__. It takes you to a page where you set up a few of the parameters for your custom menu. For arguments sake call it 'admin menu' and save settings.

Now I am going from memory, but I think it automatically takes you to the next screen where you choose what to have in your menu.

Most of what you will need will mean that you choose "URL" as the resource type. Don't get too overwhelmed by this page. Enter a title, choose "URL" and enter the url in the next box.

Save the item.

The urls are fairly intuitive. They follow the loose rules of:

{code}[nameofpackage]/[function].php{code}
Therefore
fisheye/upload.php
wiki/list_pages.php
treasury/edit_gallery.php

So once you are happy with the menu items you have for your menu, there is one last thing for you to do.

Go to __Admin>Theme>Configure layouts__

You will see the default setting for the layout of your site, and any others you have installed.

Choose to __Edit this layout(s)__ you want to have the menu on. Scroll down to the bottom of the page, to the assign column module tab.

In the drop down field for __Module__ you should see the name for your admin menu.

Select it, choose a position, and order if this is important to you.

The __key here is to select administrators in the groups box__ almost at the bottom of the page, and my recommendation is to apply it to all layouts - because you don't want to go off and work on one of the packages and either not be able to get back or not be able to insert images or whatever you feel is necessary that you added to your admin menu.
---
!!!~~red:How do I change what boxes/widgets/modules are showing on my site?~~

First let me say that you can have a different layout for (at least) each different core package that you choose to install (wiki, blogs, boards etc).

You would go to __Admin>Themes>Configure Layout Options__

Here you will find the layouts of all the packages that you have installed.

Scroll down to the one you want. Click on __'edit this layout'__ above the section.

You will see the various parts of your page - column(s), top area and bottom areas.

*To delete a module - click on the shredder
*To change the position of a module - use the arrows
*(If it is a custom module (see above 'How do I add my own html code to a box/widget?') then you will see an edit button too.)

To add a new module scroll down to the bottom of the page

Choose your Module from the drop down box

*Choose where you want it to go in the Position field.
*Give it a title
*Choose the order in which it will appear in the section that you would like to add it to.

*Select the groups of users who can see this module if you want to.
---
!!!~~red:How do I create a link to another wiki page?~~

On the page that you want to link from, put 2 open parentheses around each end of the word.

{code}((yourword)){code}
When you save this page, this word will appear to want to create a link. Simply click on the word and it will take you to creating a new page.
---
!!!~~red:How do I create a link to a board?~~

Create the board first.

Go to __Boards tab __and scroll down to __Create new Board__. Give it a title and a description as you wish and __Save__ the page.

Then go back to the __Boards tab__ and choose the __Boards Home__ option.
This lists your boards. Hover your mouse over the name of the board you want to link to and note the number of the board down the bottom of your browser.

Then on the page that you want to link from, use square bracket to enclose the path to find the board.

{code}[/sitename/boards/index.php?b=#|boardname]{code}
'sitename' will be the directory that your bitweaver was put into
'#' is the specific number of the board that you want to link directly to
'boardname' is the name that you want to appear on the page that you want to link from.
---
!!!~~red:How do I create a table of contents for a wiki page?~~

First you need to make sure that you use the exclamation marks at the beginning of any line that you want to be made into a heading.

*One '! for a big heading
*Two '!' for a medium heading
*Three '!' for a small heading

Then you click on the icon at the top of your wiki page for __Page Table of Contents__ when you are where the table of contents is to go.

It automatically picks up the headings.

For further ways you can customise your table of contents refer to the __Wiki Help__ tab.

The headings on this page for what it is worth are using '!!!', bold and colour, except the 'Where do I start?' heading which uses '!!'.
---
!!!~~red:How do I create my own menu?~~

See above "How do I block people (registered users) from seeing menu's and assign permissions?"
---
!!!~~red:How do I escape code?~~

See: How do I get code to show in a page instead of activating?
---
!!!~~red:How do I get messages sent to my email (without always having to log in to the site to read them)?~~

Go to your user profile by clicking on your user name under the log in box or via __Home page>List Users__ click on your name; choose __preferences__ (the cog icon) and __User Messages__. Select your choice for __send an email__.
---
!!!~~red:How do I get Wiki pages to link when I am using a foreign language or special characters?~~

This is still under discussion in the forums.

One person got the Wikilinks to work in the German language by:

Going to the __Admin tab__, scrolling down to __Wiki__, across to __Wiki settings__, where you see several tabbed pages. Go to the __Wiki settings__ tab. Find the __Wiki Link Format__ and choose __Complete__

And another person, also for a Wiki in German, chose: __Latin__

So go figure!
---
!!!~~red:How do I get code to show in a page instead of activating?~~

Insert the code that you want to show between a set of 'parantheses around the word __code__' like this ~pp~{code}~/pp~
So if you wanted to show {code}{attachment id=918 size=icon}{code} then it would look like

~pp~{code}{attachment id=918 size=icon}{code}~/pp~
---
!!!~~red:How do I know if someone has changed something on my site?~~

Go to __Admin>Kernel>Notification__ and select the event that you want to be notified for, choose the email address and you're done!
---
!!!~~red:How do I translate words that still show in English on my site?~~

Go to __Admin>Languages>Edit Languages__

Select your language, check the __only untranslated__ box, and click on the __edit translations__ button.

This will bring up a list indexed by letter.

Make your changes on each/any page and __save__.

At the end of your changes you will be prompted to clear the language cache - this is important so that the changes show on your site. You may also need to clear your site cache as well: __Admin>Kernel>System Cache__

To edit words or phrases that you wish to be translated differently simply leave the 'untranslated' field unchecked and you will get a very big listing of all the words/phrases.

If you'd like to help other uers by your translation efforts, please see [http://www.bitweaver.org/wiki/TranslationTutorial|this page.]
---
!!!~~red:How do I use html in a Wiki page?~~

Wiki pages are usually written in Wiki Markup language. So to include html (another language) you need to have the __Allow html__ checked in the __Admin>Liberty>Plugins__ area, under __Format Plugins__ - see the box there?

When I was asking one of the developers about using html in the wiki, he suggested also checking the box for the HTML Purifier which you will find in the __Admin>Liberty>Plugins__ area.

You will also need to go to the Group Permissions area and adjust which groups are allowed to use this feature. [http://www.bitweaver.org/wiki/edit.php#HowdoIblockpeopleregisteredusersfromseei|See above.]

Otherwise you may choose not to have the Wiki Markup language enabled and instead choose an html option in the __Format Plugins__ area.
---
!!!~~red:I used '/' in my wiki page title and now the backlinks don't work~~

Unfortunately because most, if not all web servers, are controlled by Apache (mod_rewrite), it doesn't like the use of an '/' in combination with __Pretty URLs__.

So the only solution, if you want to use '/' is to turn off Pretty URLs:

Admin>Kernel>Settings - Make sure 'Use Pretty Urls' is unchecked and remember to click on 'Change preferences' down the bottom of the page.
---
!!!~~red:Some words in the Wiki think they are links~~

This is because BW automagically (ie 'hey presto') thinks words that have an underscore or a hyphen in them, or that are written in caps, are going to be a new page.

An underscore is a common way for titles to be written instead of running all the words together.

So if this is annoying you, you will need to go to the __Admin__ drop-down menu, choose __Wiki__ and slide across to __Wiki settings__.

You will see a series of tabbed pages. Click on the __In and Output__ tab

On this page is the checkbox for__ Wikiwords__. (I understand these were called Hotwords in previous versions perhaps). If you uncheck it, then you won't have the 'problem' with words wanting to be links.

Remember to go to the bottom of the page and choose __Change Preferences__
---
!!!~~red:The group permissions have changed~~

Have you recently upgraded from 2.0 to 2.1? If so there have been a few changes in the databases and tables.

This means that the permissions that are in the __Admin>Users>Groups & Permissions__ are only for the packages you have chosen. The global list got too big to have everything itemised out, and lets face it, it gets tedious to have to wade through stuff you don't need.

So now when you select a new package to include in your BW site, you will then ALSO need to go to the 'Groups and Permissions' area and assign the relevant permissions.
---
!!!~~red:What about anonymous visitors to my site?~~

See above 'How do I block people (registered users) from seeing menu's and assign permissions?' for where in BW the permissions etc are.

*The easiest way I found, and for each installation it will be different depending on what packages you install first, was to go to __Kernel>Kernel settings__ and the __homepage tab__.

I chose __custom home__ in the drop down home page field, and then entered the internal url for the single standalone page that I had made as a front page for my site. In this case: wiki/welcome

Remember to click on the __change preferences__ at the bottom of the page.

*For those whose home page will not be changing for their site, I believe you can go about this another way.

Go to the page that is your home page and click on the __Assign permissions__ icon in the top right. I understand this allows you to assign permissions (that override the global permissions) for this one page.
---
!!!~~red:What are those words in parentheses/ curly brackets? And how do I use them?~~

These are helpful commands that are already programmed into the code so you don't have to.

For example {code}{COUNTDOWN}{code}
If you simply type this in your Wiki page for example, as it is, a 'help' will pop up when you preview your page alerting you to the things that you need to add to it for it to work the way that it was programmed to do. (Or look at your Wiki help tab).

So lets say that we wanted a countdown since the day we installed BW, then we would add:

enddate='Jul 16 2008' localtime='on' text='since I started to use Bitweaver'

inside the parentheses, after the word 'countdown'

So it would all look like this:

{code}{COUNTDOWN enddate='Jul 16 2008' localtime='on' text='since I started to use Bitweaver'}{code}
I couldn't get it to render though in this wikipage!!

A full list of what you have installed is on the __Wiki Help__ page in the __Data Plugins__ box. To install or uninstall these plugins, go to __Admin>Liberty>Plugins__
---
!!!~~red:What is a Stencil?~~

It's a way to make entering data into many same wiki pages uniform. A stencil is set up exactly how you want the data displayed (ie table or paragraph) and then a piece of code that is generated from your stencil is placed in your chosen wiki page, that prompts a person to input certain values during the edit process that when the page is saved renders these as per the manner that the stencil has been set up to do.

So for example you had several pages for family members to enter information about themselves, and you wanted to make them all look the same, you could generate a stencil with first name, surname, birthday, country and then put the code that this generates into individual family member pages for them to fill in when they edit it.
---
!!!~~red:What is a Wiki Book?~~

It is a collection of content from your Bitweaver site - not limited to your Wiki pages, presented like a book. Think of it as a publishing tool for a thesis or report.

One of the Wiki pages that is already in your installation of Bitweaver is __"How to create a Wiki Book"__ or you could just as simply click on __Wiki__ and __Create a Wiki book__ Its fairly straight forward. The page or content needs to be there first though.

If when you go to __Add content__ on the Wiki book page you only see Wiki pages and you know that you have an image or a board to add - use the drop down menu at the top of the page to find the other content types.
---
!!!~~red:What is the difference between tags, pigeonholes and categories?~~

What they have in common is that they can be used to group content together, regardless of the content's type: - images, galleries, wiki pages, comments, blog postings etc can all be grouped together to one theme ie "last year's wedding". (Much like a wiki book - see above.)

The 'Tags Package' is everything you read at Wikipedia about tags. Users input keywords, they are displayed as a cloud or as a list. They are non-hierarchical. (Grouping of tags like del.icio.us is not possible (yet).) To put it another way, they are random words that the user decides to describe the content. They evolve with the users and the site.

'Pigeonholes' and 'Categories', on the other hand, are both categorization packages. The basic concept is a hierarchical one. 'Pigeonholes' is fundamentally better than 'Categories'. To see at the features go to __Admin>Pigeonholes>Settings__.

Categorisation is pre-determined (usually by the site administrator or those with permissions to do so).

Pigeonholes has more features and modules. You can display content that belongs to each other in a side module, or you can apply a different site style depending on the category as a couple of examples.

A source of confusion might be, that Categories and Pigeonholes are both category-packages, but only one of them is named like that. The reason for that is the modularity of Bitweaver.

(See below 'Why are there so many packages in Bitweaver?'
---
!!!~~red:Why are there so many packages in Bitweaver?~~

There is not one package for each content type - there are many - "Packages are king!".

To handle images, you can use Fisheye, Gallery2 (?), or write your own package (and name it as you like). There isn't really one "Bitweaver image gallery package" or "Bitweaver categorization package".

If you write your own package you can name it for its function, subsequent packages normally adopt synonymous names. If you're writing a Tags package now or an Events package, there are two names that you probably wouldn't pick. (You can instead extend an existing package instead of writing one from scratch!)

Two other packages that overlap in function are 'Stars' and 'Recommends', as well as 'Search' and 'Ilike'
---






---
!!!~~red:Where do I start? Where to from here?~~

Now you are ready to select the packages that you need for your site.

Read the description of each and consider if you REALLY need it - focus on the main component(s) of your site - you can enable packages again in the future.

There is so much potential with this CMS that it will blow your mind.


!!! See also:
* ((Top 10 reasons to use Bitweaver))
* ((WhybitweaverIsCool|Why Bitweaver is Cool))
* ((Top 10 mistakes after installing Bitweaver))
Page History
Date/CommentUserIPVersion
19 Mar 2009 (22:41 UTC)
module assignments for reg users
kinderlehrer118.90.85.15877
Current • Source
kinderlehrer118.90.64.12676
View • Compare • Difference • Source
kinderlehrer118.90.100.11175
View • Compare • Difference • Source
kinderlehrer118.90.100.11173
View • Compare • Difference • Source
kinderlehrer118.90.108.10871
View • Compare • Difference • Source
kinderlehrer118.90.108.10870
View • Compare • Difference • Source
kinderlehrer118.90.108.10869
View • Compare • Difference • Source
kinderlehrer118.90.87.14968
View • Compare • Difference • Source
laetzer85.177.83.3667
View • Compare • Difference • Source
kinderlehrer118.90.87.14966
View • Compare • Difference • Source
kinderlehrer118.90.87.14965
View • Compare • Difference • Source
kinderlehrer118.90.70.19864
View • Compare • Difference • Source
Kozuch85.207.244.16063
View • Compare • Difference • Source
kinderlehrer118.90.70.19862
View • Compare • Difference • Source
kinderlehrer118.90.70.19861
View • Compare • Difference • Source
kinderlehrer118.90.70.19860
View • Compare • Difference • Source
kinderlehrer118.90.21.12658
View • Compare • Difference • Source
kinderlehrer118.90.21.12657
View • Compare • Difference • Source
kinderlehrer118.90.21.12656
View • Compare • Difference • Source
kinderlehrer118.90.21.12655
View • Compare • Difference • Source
kinderlehrer118.90.21.12654
View • Compare • Difference • Source
kinderlehrer118.90.21.12648
View • Compare • Difference • Source
laetzer85.178.10.3746
View • Compare • Difference • Source
Kozuch85.207.244.16045
View • Compare • Difference • Source
kinderlehrer118.90.99.22544
View • Compare • Difference • Source
kinderlehrer118.90.99.22542
View • Compare • Difference • Source