Page History
| Table of Contents | ||
|---|---|---|
|
Why contribute to the KnowledgeBase?
The success of any open-source project lies with the community contributing its collective energy, knowledge, enthusiasm, and effort. The KnowledgeBase is a resource developed and monitored by the user communities to benefit potential, new and existing DSpace or Fedora users. Join with us in the effort and become a content contributor or a content moderator.
Contribute to the KnowledgeBase and Win Amazon Gift Cards!
For details click here.
KnowledgeBase Structure and Navigation
The primary delivery framework for the KnowledgeBase is the text-based wiki guide. The DuraSpace KnowledgeBase includes three separate Confluence wiki "spaces":
- the umbrella DuraSpace KnowledgeBased, used for general content and information (such as this guide)
- DSpace KnowledgeBase
- Fedora KnowledgeBase
Each KnowledgeBase has a left-hand navigation menu which provides an easy way to find your way around to various topics and sub-topics, represented as separate pages and sub-pages, as well as the ability to jump between the different KnowledgeBase "spaces". A fully expanded view of the navigation menu or site map can be viewed here: DSpace Site Map, Fedora Site Map. The topics and sub-topics can be further developed or changed by creating new pages and/or new children or sub-pages. You may propose new subjects by creating a blank page in the appropriate location, a title, and copying and pasting the text-based template to/from the Wiki Markup editor.
In addition to the navigation menu of topics, the KnowledgeBase has been seeded with a small sampling of content. Contributors can use these samples to get an idea of how to create new content as well as reviewing this page for guidelines and suggestions for content development.
We welcome all contributions and ask that you please make use of the guidelines and suggestions in this section. If you have any questions or feedback, please contact Valorie Hollister at vhollister@duraspace.org.
Using Comment Section
Because monitoring the content is a community effort there is a possibility that something may be missed. If you see something out-of-date or erroneous, please either update the information or use the "Comment" section at the bottom of each page indicate the information is "incomplete", "out of date" or "erroneous". There is an Work In Progress page for both the DSpace KnowledgeBase and the Fedora KnowledgeBase which identifies the pages currently identified as "incomplete". Other search pages can be built to navigate other status dimensions.
Using Status Banners
We are exploring ideas for using banners to indicate the status of content (e.g. if content is considered current, complete, or needs amplification, incomplete, etc.). For now all the pages with missing content have a status banner that indicates
| Include Page | ||||
|---|---|---|---|---|
|
Standard inclusions
There are few standard content, wiki syntax fragments and status banners that you can include to indicate common messages or formats on KnowledgeBase pages. These can be found on the Page Inclusions page.
Content Contributors
KnowledgeBase content is created by individuals from the user communities. Contributors do not need to be a developer or even an expert in order to develop content. If you have experience using DSpace or Fedora, know a lot about a particular feature/functionality and/or if you know how to communicate information effectively, we welcome your contribution. We are always looking for content contributors (people to willing to write/present/edit content) as well as content moderators (people who review and provide feedback to content contributors).
All KnowledgeBase content, like the rest of the DuraSpace wiki, is licensed under a a Creative Commons Atrribution-Share Alike 3.0 License and is created by members of the user communities for the benefit of other users. Anyone is free to share and remix the content, with the hope that any remix will also be shared and appropriate attribution footnoted. All contributors are encouraged to include an author attribution footnote on content they create. Contributors are encouraged to include a hyperlink/s to their personal profile and/or their organizaiton's website.
| Panel |
|---|
Example of author attribution footnote: "This content was contributed by John Smith from the University of Michigan and Betsy Jones from the University of Illinois" |
Delivery Tools
The KnowledgeBase is designed to communicate information using a variety of modalities. Since not all people take in information in the same way, the intention is to offer a text based guide, short recorded screencasts, presentation slides as well as available webinar recordings. All of the content can be found in the KnowledgeBase wiki, integrated into the Table of Contents framework.
Text-based Content and Images
Text content and relevant images (screen shots, diagrams, etc.) are the foundation of the KnowledgeBase wiki. The KnoweldgeBase uses the Confluence "Documentation Theme" and has been customized to provide a unique look and feel. The information is organized based on a draft Table of Contents proposed by DuraSpace in consultation with community members. Community members should feel free to change/add topic items as they see necessary. Detailed guidelines/recommendations for creating text based content, including a template, can be found here.
Screencasts
Screencasts are available to provide users with a quick visual 'how to' reference. Screencast videos appear as embedded links through out the KnowledgeBase and are generally stored on Youtube.com. Detailed guidelines/recommendations for creating screencasts can be found here.
Presentation Slides
There are many useful conference presentations which take a deep dive on topics. While the usefulness of some presentations can be time sensitive, many have long term value to the community. Slides files appear as embedded links throughout the KnowledgeBase and are generally stored on Slideshare. Detailed guidelines/recommendations for posting slides can be found here.
Webinars
There are several useful recorded webinar presentations which provide an in-depth discussion on topics. Webinars appear as embedded links throughout the KnowledgeBase and are generally stored on Youtube.com. Detailed guidelines/recommendations for posting slides can be found here.
Content Moderators
Content moderators help to manage to the content contributions to the KnowledgeBase. They review content and help ensure it is either accurate or flagged as being out-of-date or erroneous. They may also provide feedback and suggestions to content contributors as well as help to find content contributors. Because monitoring the content is a community effort there is a possibility that something may be missed. If you see something out-of-date or erroneous, please either update the information or use the "Comment" section at the bottom of each page indicate the information is "out of date" or "erroneous".
Goal:
...
Improve entry level experience, show what technologies can do - what it is, why do I need it, DSpace vs. Fedora - why chose one over the other, use cases examples, how to set up a repo and get started.
...
Strategy:
...
Collaboratively develop on-line materials (similar to Ruby's RailGuides: http://guides.rubyonrails.org/). Each topic will have: (a) Screencast, (b) Text-based Guide, (c) Powerpoint slides, and, if available (d) link to relevant video/webinar.
...
Next steps
...
- create table of content page and a team for each project, solicit feedback
- create wiki space for education curriculum
- create examples for each vehicle: (a) Screencast, (b) Text-based Guide, (c) Powerpoint based
- DSpace:
- Basic intro on XMLUI - w/screencast, text guide and Powerpoint
- install/set up process (paragraph descriptor only w/references and future plans)
- What is DSpace?/Why use DSpace? Jonathan working on already
- Fedora:
- installation
- conceptual Fedora (what is an object? what is a Fedora repository?)
- What is Fedora? Why use Fedora? Jonathan working on already
- DSpace:
- develop a contributor process
- all materials need to be reviewed/approved - make sure information is accurate and there are no writes violation, ensure a copy is permanently stored in a repository
- all contributors to sign license agreements - Apache 2 both ICLA (individual) and CCLA (corporate) licences, and then Creative Commons on the content - use one of the some rights reserved - future opp to pkg up and profit from it
Delivery Tools
-vimeo account for video - link to w/in the guide, people will have to submit the videos to us so we can put it in our vimeo acct
-slideshare account for powerpoint
-copies should be permanently archived/stored in a repository
Confluence Tools
Embedding Video/Slides using Confluence's Widget Connector
(http://confluence.atlassian.com/display/DOC/Widget+Connector+Examples)
Examples of embedding Vimeo, Flickr, YouTube, SlideShare, etc. into Confluence.
Screencast.com Widget Connector Extension
(https://plugins.atlassian.com/plugin/details/33430)
Jing, Camtasia, Screencast.com videos can now be embedded in Confluence using the Widget Connector.
ScreenSnipe for Confluence
(https://plugins.atlassian.com/plugin/details/28446)
Create easy and powerful screenshots at hand - directly from your Confluence (with no client-side installation). Creating beautiful and informative release notes, technical documentation or clear, visual comments was never simpler.
TaskDock for Confluence
(https://plugins.atlassian.com/plugin/details/13744)
Communication and workflow for your content. Project tracking, tasks, and messaging for your wiki. Includes JIRA integration.
How to Create a Screencast for the DuraSpace Educational Curriculum
Introduction
A screencast is a video of someone showing how to do something on a computer. The screencast software captures what is happening on the computer screen along with an audio recording of the speaker explaining what he or she is doing. Many people enjoy learning online procedures from screencasts, and the DuraSpace Educational Curriculum makes frequent use of the screencast format for teaching people how to use or deploy our software.
You can create your own screencast and contribute the resulting video to the online Educational Curriculum. There are four parts to creating screencasts: 1. Planning what you are going to present, 2. Choosing screencast recording software, 3. Making the recording, and 4. Producing the final screencast video. This guide will walk you through those steps.
Planning
First, select one of the curriculum topics for your screencast from the table of contents for one of the products. Good topics for screencasts are ones that show people steps for completing a task online. The viewer will be watching a recording of your computer screen, following your mouse movements, and listening to your explanation of what you are doing. To the extent that your recording is clear, interesting to watch, and instructive, your screencast will be a success. Here are some guidelines for planning your screencast:
- Pick a topic from the curriculum table of contents for DSpace (insert link) or Fedora (insert link). Make sure you give your screencast the same name as the curriculum item you've chosen
- An effective screencast lasts in the neighborhood of five minutes. It might be necessary to go longer if you are describing a process that needs to be presented in one piece. On the other hand, you may want to divide your topic into two or more screencasts, if appropriate (e.g., "Getting Started with DSpace Access Controls, Part One" and "...Part Two").
- Do you need to write out a script for your screencast? Perhaps, but not necessarily. A simple outline might do, or just some reminders on a page. Informal, extemporaneous screencasts are not at all uncommon on the Internet. You may find it easier not to juggle a written script while you're navigating through the flow of screens.
- Make sure your computer software is configured for the screencast. In addition to the screencast software (more on that later), you will probably need to have an application environment set up for whatever you are going to demonstrate.
- Best bet for quality audio is to use a headset with microphone. We have found that the Logitech USB headsets work very well, but most any USB headset should do nicely.
Choosing Screencast Software
Video Tools
The following tools may all be used to perform Screen and Audio capture for Screencasts:
...
Tool Name / Link
...
Cost
...
Platforms
...
C ontainers and Codecs
...
Notes
...
xvidcap
...
Free
...
Linux
...
mpeg(4), avi, mov, others, with sorenson, divx, mpeg, others.
...
Default versions do not work with pulseaudio, and thus recent Ubuntu installations (Ubuntu 11.4 and 11.10). Workaround is to install from source, and launch with padsp. Provides a GUI, easy to use
...
ffmpeg
...
Free
...
Linux
...
Anything except apple pro
...
Pure command line tool. For Ubuntu, must build from source (directions), and then command lines like these. FFmpeg is also suitable for format conversion and audio overlay.
...
recordmydesktop
gtk-recordmydesktop
...
Free
...
Linux
...
ogv (must transcode results, can use transmageddon)
...
Works out of the box on Ubuntu 11.10
...
...
Free
(Pro is $12/year)
...
Windows, Mac, Linux
...
MP4, AVI, FLV (also save directly to YouTubeHD or Screencast-o-matic.com acct)
...
Runs from browser (Java applet), but records any screen/desktop activities. Has an easy setting for recording in "Full HD" resolution (1280x720). Can auto-letterbox smaller resolution recordings when saving. Very easy to use. Can highlight mouse cursor & all mouse clicks. 15-minute recording limit (Pro is unlimited). Videos are branded with a small logo in lower left corner (Pro version is free of branding).
...
...
Free
(Pro is $14.95/year)
...
Windows or Mac
...
FLV (Pro version also offers MP4)
...
Easy to use, but has minimal options. Seem to only be able to record either full-screen or a specific window (no options to record a selected area or part of screen). 5-minute recording limit. Videos are branded (Pro version is free of branding).
...
...
Free
(Open Source!)
...
Windows
...
AVI or FLV
...
Lots of options/configurations available (most often compared to Camtasia in terms of options). Not always as easy to use or user friendly as other free screencasting tools (see Screencast-O-Matic or Jing), but it definitely comes with options & tools comparable to Camtasia.
...
...
$299
(30-day free trial available)
...
Windows or Mac
...
MP4, M4V, AVI, FLV, Silverlight, MOV, RM
...
Overview
Content Tools