C
carcher
my most humble thanks,
(e-mail address removed)
(e-mail address removed)
strive4peace said:steps to document a database
~~~
Hi Carol,
sned me email and I will send you the sample database to show images
from a continuous subform ... sorry I don't have much time right now to
explain it.
*** Steps for Documenting a database ***
Make a PowerPoint presentation and choose blank slide (no placeholders)
Even if you have never used PowerPoint, it is not hard. A presentation
is a collection of slides. I like to use PowerPoint because the default
is landscape, which fits a screen nicely.
To create a new presentation, press CTRL-N (New). To create a new slide,
press CTRL-M (Mew slide meow!). To save, press CTRL-S and pay attention
to where it goes!
switch between application you are documenting and PowerPoint (ppt)
to copy screen to Clipboard, press PrintScreen key on your keyboard
to paste contents of Clipboard, press CTRL-V
put screen dumps on separate slides
Document ScreenDumps of:
: design view of forms
(my hidden controls are always colored dark)
: form view of forms
: design view of reports
: report view of reports
: design view of each query and paste SQL in textbox on the slide (add
line breaks in SQL so that each RESERVED word starts a new line. Format
text as ARIAL 8 point. Becoming familiar with SQL (Standard Query
Language) is very valuable.
: output of each query (just one screen is enough)
: relationships with tables expanded so you can see all the fields
(include all tables, even those without links)
Save and Print ppt presentation
Print all code -- I like to copy it into Word and format it for easier
readability, and build a Table of Contents (Insert, Index and Tables...)
using the Heading style tags (Heading1 ALT-CTRL-1 for the name of the
module, Heading2 ALT-CTRL-2 for the sub/function declaration, Heading3
alt-ctrl-3 for whatever). FYI, all paragraphs are called "Normal" unless
you change their style name -- a GREAT feature of Word that not too many
people know about.
get a marker and label all controls with the Name property so when you
read through the code, you can see what it is referring to. It is also
helpful to label the ControlSource if it is different -- I like to Name
my controls the same as the ControlSource to avoid confusion.
Get a lined piece of paper for each form and write each form name at the
top and underline
click on each control in design view of form, whenever there is an
event, note it on your paper along with the sub/function that it runs.
ie:
form BeforeUpdate = UpdateMe()
It will take you a few hours to make a good reference like this and then
a few hours to understand what is happening, but you'll save lots of
time for yourself because you will take a whole different approach to
setting up databases.
*** steps to document VBA code using Word ***
Create a Word Document
File, Page Setup
top = 0.5
bottom = 0.5
left = 0.75
right=0.5
header = 0.3
Format, Style...
choose Normal
click Modify...
Format command button
Font... Arial, 8
OK, OK, Close
save your word doc in the directory with the database you are documenting
then, switch to your Access database
1. open the design view of each module
2. selected all code and copy (CTRL-A, CTRL-C)
3. switched to word
4. type in module name
5. format as Heading1 (CTRL-ALT-1)
6. press ENTER to create new line
7. paste code (CTRL-V)
8. press ENTER to create new line
9. repeat process from step 1 till done
once all the code is in word,
in replace dialog box, click More
search --> ^pPrivate (space)
replace --> ^pPrivate (space)
--> Heading2
^p is code for paragraph marker (Special command button)
Then, Replace All
also do for:
^pFunction (space)
^pSub (space)
to add Heading2 to what you replace with:
1. make sure you are in the ReplaceTo box
2. drop Format (from the "More" part at the bottom of the dialog box)
3. choose Style...
4. choose Heading2
***
add Header to document
View, Header and Footer
Database Name - documented [current date] for db modified [db mod date]
- {PageNo}/{Pages}
where
info in brackets is to be inserted by you
{PageNo} and {Pages} are variable icons on the Header/Footer toolbar for
the page number and the number of pages
I put header in italics and right -align
***
To create Table of Contents
1. go to end of document (CTRL-END)
2. create new line (ENTER)
3. create page break (CTRL-ENTER)
4. Type "Table of Contents" ENTER ENTER
5. from the menu: Insert, Index and Tables... Table of Contents tab
6. OK
format :
TOC1
font --> Arial 12 bold
Paragraph Space Above = 6 points
TOC2
font --> Arial 10 bold
Paragraph Space Above = 1 point
***
enhance documentation
It would be good to enhance the documentation with:
screen shot of design view and form/preview for each object. Save shots as
JPG. Insert picture into documentation between the module name and the code.
If you want to take this one step further, turn on the drawing toolbar
and label all controls (except labels, unless they have code) with their
NAME and CONTROLSOURCE (if equation, or is different than name).
***
To update the Table of Contents
click on any TOC line
press F9 to Update
***
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If anyone else wants a copy of the database, email me with this as the
subject:
Show Images from Continuous Subform
I will post it on the Internet sometime, probably here:
http://www.accessmvp.com
Warm Regards,
Crystal
strive4peace2006 at yahoo.com
*
have an awesome day
*
I really appreciate your help and patience. I apologize for the
inconvenience, and I do want to learn all that I can...I'm just having
trouble getting over this hurdle. I'm continuing to read all that I can find
and trying to apply it, but it is overwhelming right now.
Thank you again,
carol