Contents
1 Introduction................................................................................................ 1
2 Requirements............................................................................................. 1
2.1 Hardware ............................................................................................... 1
2.2 Software ................................................................................................ 1
3 Installation.................................................................................................. 1
4 Application Usage ..................................................................................... 2
4.1 Start PBcode ......................................................................................... 2
4.2 Automatic Backup.................................................................................. 2
4.3 Automatic Database Creation................................................................ 3
4.4 The Application Window ........................................................................ 3
4.5 Top Bar.................................................................................................. 4
4.5.1 Reset Application.......................................................................... 4
4.5.2 Move the Window ......................................................................... 4
4.5.3 Minimize the Window.................................................................... 5
4.5.4 Maximize the Window................................................................... 5
4.5.5 Exit the Application ....................................................................... 5
4.5.6 Search Function............................................................................ 5
4.6 Panel Area............................................................................................. 6
4.6.1 Home Panel .................................................................................. 6
4.6.2 Information panel .......................................................................... 7
4.6.3 Code Panel ................................................................................... 8
4.6.4 Search Results Panel ................................................................... 9
4.7 Bottom Bar........................................................................................... 10
4.7.1 Add a new Record ...................................................................... 10
4.7.2 Save / Update a Record ............................................................. 10
4.7.3 Record Navigation ...................................................................... 10
4.7.4 Enable / Disable the Edit Mode .................................................. 10
4.7.5 Delete a Record.......................................................................... 10
5 Feedback .................................................................................................. 11
PBcode - User Manual
1 Introduction
PBcode is a small application which stores scripts, functions or other code
for developers into his database. An integrated search function helps to
find the code when needed. With a mouse click the code can be copied to
the clipboard or inserted from the clipboard. We hope you will like the
application. This manual will show you how to get started with PBcode.
2 Requirements
PBcode has very low hard- and software requirements. The following
checklist will help you to determine if the hard- and software of your
system meets the specific needs.
2.1 Hardware
Personal computer (PC) with mouse
128 MB of memory (RAM)
15 MB of free harddisk space
Screen resolution of 1024 x 768 pixel
2.2 Software
Operating System: Windows XP or higher
3 Installation
If you have downloaded PBcode, check if the MD5 hash from our website
matches so you can be sure that the file was not modified. Then unpack
the archive. That is the whole installation procedure.
Page 1 of 11
PBcode - User Manual
4 Application Usage
4.1 Start PBcode
To start PBcode just double-click on the file “PBcode.exe” inside the
folder “PBcode 1.0”.
4.2 Automatic Backup
During each application start the actual database will be copied into
the subfolder “Backup”. The database copies are named from
“Backup_1.rsd” to “Backup_7.rsd”. Always the last seven backups
are available.
If no database exists an error message will be displayed to inform
you about the problem:
Page 2 of 11
PBcode - User Manual
4.3 Automatic Database Creation
If no database exists the PBcode application will create a new and
empty one:
4.4 The Application Window
After the PBcode application has started the main window will be
displayed. The window is resizable so that you can specify the
window size that best fits your needs.
Page 3 of 11
PBcode - User Manual
The application window has three areas like displayed on the
following image:
4.5 Top Bar
The first area is the “Top Bar” (yellow) which includes the application
title, some navigation buttons and the search function.
4.5.1 Reset Application
To reset the application, click on the button “Reset” from the
top bar of the window. All search results will be cleared and
the home panel will be displayed. This does not alter the
database !
4.5.2 Move the Window
To move the window, click on the area “Move” from the top
bar of the window and drag the window.
Page 4 of 11
PBcode - User Manual
4.5.3 Minimize the Window
To minimize the window, click on the button “Minimize” from
the top bar of the window.
4.5.4 Maximize the Window
To maximize the window, click on the button “Maximize” from
the top bar of the window.
4.5.5 Exit the Application
To exit the application, click on the button “Exit” from the top
bar of the window.
4.5.6 Search Function
Below the buttons from the top bar you can see the search
input field. If you enter a search term you can press “Enter” to
start the search or you can click on the button “Search” on the
right side. If there are any matches the panel “Search
Results” will display them in table form. You can click on an
entry to display the record.
Page 5 of 11
PBcode - User Manual
4.6 Panel Area
The second area is the “Panel Area” (orange) which displays the
information from the database.
4.6.1 Home Panel
There exist four different panels. The first one is the “Home”
panel. If you click on the company logo a small window with
additional information about the application will be displayed.
Page 6 of 11
PBcode - User Manual
4.6.2 Information panel
The second panel is the “Information” panel. This panel
holds the information about a code snippet and not the code
itself. Here you can enter the languages, title and keywords
for the code snippet. Below there is a text area where you can
enter an explanation on how to use the code, the hard- and
software requirements etc.
There is a link to copy the information from the text area to the
clipboard and another link to copy the text from the clipboard
to the text area.
Page 7 of 11
PBcode - User Manual
4.6.3 Code Panel
The third panel called “Code” finally holds the program code.
There is a link to copy the information from the text area to the
clipboard and another link to copy the text from the clipboard
to the text area.
If the checkbox “Add borders” is selected the text copied to
the clipboard contains a border at the beginning and a border
at the end.
Page 8 of 11
PBcode - User Manual
4.6.4 Search Results Panel
The fourth panel named “Search Results” displays the
matching results from a database query.
The link “Display all records” will display all the records from
the database.
If you click on one of the table headers you can sort the
entries.
Page 9 of 11
PBcode - User Manual
4.7 Bottom Bar
The third area is the “Bottom Bar” (red) which includes the elements
necessary to alter the database.
4.7.1 Add a new Record
To add a new record to the database press the button “New”.
The panel “Information” will be displayed with a new empty
record.
4.7.2 Save / Update a Record
To save a new record or update an existing one press the
button “Save” / “Update”. The changes will be stored into the
database.
4.7.3 Record Navigation
To step through the records use the record navigation tool.
4.7.4 Enable / Disable the Edit Mode
If you want to alter the database you have to enable the “Edit
Mode” first. Please select the checkbox to make changes to
the database and unselect the checkbox after the changes
are made.
4.7.5 Delete a Record
To delete a database record press the button “Delete”. The
actual record will be deleted.
Page 10 of 11
PBcode - User Manual
5 Feedback
We always like feedback from you so that we can improve / enhance our
products. We don’t want only positive feedback; we also like constructive
criticism so we can change for the better.
If you think there is something missing in this manual, please contact our
support so that we can add it in the next release !
Our website: http://www.pb-soft.com
Thank you for your attention !
Patrick Biegel
Page 11 of 11
">