Content Layer |
---|
| Content Column |
---|
|
Content Block |
---|
|
Document Properties Marker |
---|
doctype | project |
---|
hide | true |
---|
override | true |
---|
|
Doctype | project | hide |
---|
Name | projectdoc Demonstration Space | Short Description | The demonstration space of projectdoc features. Create this space in your Confluence instance using a space blueprint 'projectdoc Demonstration Space'. | Tags | | Sort Key | hide | documentation-json-uri | https://www.smartics.eu/confluence/download/attachments/12156954/docmap.json?api=v2 | hide |
---|
Welcome to projectdoc!
This is a starting space to show some of the projectdoc features.
Note Box |
---|
This space can be created by users creating the projectdoc Demonstration Space. |
Widget Connector |
---|
url | https://www.youtube.com/watch?v=9uI1FBUR4i8 |
---|
|
Or step through at your own pace using the presentation with Prezi !
See projectdoc Introduction for more information on all the fancy topics in the video!
Panel |
---|
borderColor | darkgreen |
---|
bgColor | lightgreen |
---|
titleColor | white |
---|
borderWidth | 3 |
---|
titleBGColor | darkgreen |
---|
borderStyle | solid |
---|
title | What Problem does projectdoc solve? |
---|
|
The ProblemWikis are a great way to add documents relevant for a software development project. After a splendid couple of weeks the highly motivated team added plenty of information to this space. But step by step the information is often difficult to find, because wikis impose very little structure on the documentation architecture. New information is difficult to add, since no one keeps track on the overall goal of the documentation endeavour. The Solutionprojectdoc tackles these issues by adding structure to the organisation of documents and structure to the individual document types. The team can still benefit from the lightweight approach by using a wiki (instead of a specialized tool or content management system), and combine them with structures the team agrees upon. projectdoc supports agile teams in writing project documentation collaboratively. It is particularly useful for projects where everyone on the team is (potentially) involved in creating documentation. |
Panel |
---|
|
Table of Contents |
---|
maxLevel | 3 |
---|
minLevel | 2 |
---|
outline | true |
---|
indent | 10px |
---|
exclude | Resources |
---|
style | none |
---|
|
|
Info Box |
---|
You may use this as a base for your real spaces, too. Instead we recommend to install free doctype add-ons that meet your documentation requirements better and start by creating spaces with the blueprints provided by these add-ons. |
Panel |
---|
borderColor | orange |
---|
borderWidth | 3 |
---|
|
ResourcesIn case you are looking for information on how to use projectdoc, we recommend the following resources on the internet: |
Section |
---|
level | 2 |
---|
title | Basic Features Show |
---|
|
Here we introduce you to some of the features of projectdoc.
Section |
---|
level | 3 |
---|
title | Selecting Documents with Automatic Lists |
---|
|
The space has been created with three documents of type "doctype-addon". Usually you would create a template for them, but we added them manually to show you how to select on documents you provide.
The following tables are examples using the Display Table Macro. It allows to select on projectdoc documents based on document properties. The document properties are stored in the table on top of each projectdoc page. A projectdoc pages is essentially a Confluence page the uses the Document Properties Marker Macro constraining the properties table and the Section Macro for defining the sections.
Please note that this example is somewhat artificial: usually a template author would define a doctype for the "doctype-addon" type and define the properties and sections that are part of it.
Panel |
---|
bgColor | lightyellow |
---|
titleBGColor | white |
---|
title | Display Table Examples |
---|
|
Section |
---|
| This example shows the selected pages in classic tabular form. |
Section |
---|
level | 4 |
---|
title | Same Table rendered as Definition List |
---|
| Since the result of the previous example contains only two columns, it may be rendered easily as a definition list. Here it is: Panel |
---|
| Display Table |
---|
doctype | doctype-addon |
---|
render-mode | definition |
---|
|
|
|
Section |
---|
level | 4 |
---|
title | Same Table rendering Sections and Properties |
---|
| You are not restricted on selecting properties. Information from sections may also be included. In this example we also change the representation, since the amount of information in the sections is quite large and will be hard to read in its classic tabular form. Note that we also replaced the property name "Install via" with "Available on", just to show you that you may change the column headers easily. Panel |
---|
| Display Table |
---|
doctype | doctype-addon |
---|
render-mode | 5+ |
---|
select | Name, Description, Requirements, Homepage, Install via |
---|
header-translations | Install via=Available on |
---|
|
|
|
|
Section |
---|
level | 3 |
---|
title | Selecting Document Properties |
---|
|
Single sourcing is to have a single place where you store one information. If you want to show this information in another place you do this via transclusion. Transclusion is the technical term for "fetching the information just-in-time and displaying it in another context". Panel |
---|
bgColor | lightyellow |
---|
titleBGColor | white |
---|
title | Display Property Example |
---|
| For transcluding document properties there are a couple of macros, but the most basic is Display Document Property: Display Property |
---|
document | Core Doctypes Demo Page |
---|
property-name | Homepage |
---|
|
|
|
Section |
---|
|
You may also employ single sourcing via the Transclusion Macro. This macro allows to transclude any section defined with the Section Macro.
Panel |
---|
bgColor | lightyellow |
---|
titleBGColor | white |
---|
title | Transclusion Example |
---|
|
Transclusion |
---|
document | Core Doctypes Demo Page |
---|
ids | Description |
---|
|
Use transclusion to define content at one place and use with a number of documents.
Tip Box |
---|
The requirement sections of the sample "doctype-addon" documents would naturally call for such a treatment. |
Hide From Reader |
---|
Note that you only see a reference box around the transcluded content, if you are not a reader. As an author this helps you to jump to the original source quickly! Tip Box |
---|
Please also note that you have access to this tip only, because you are in the role of an author. This paragraph is hidden from users with only read access. |
|
Section |
---|
|
You have already seen on feature of the Section Macro: its content may be transcluded. The other important feature is, that you do not see the section, if the body of the section is empty! This makes it a valuable tool for template authors. A template may define the order of sections, but if there is no content, the reader's view is not cluttered with non-information. Panel |
---|
bgColor | lightyellow |
---|
titleBGColor | white |
---|
title | Transclusion Example |
---|
| Have a look at any of the following documents. Each has a section called "FAQ", but since no content is provided, the section is not rendered in view mode. Switch to the edit mode and find the FAQ section at the end of each document. |
Sections make it also easier to move them around a document per drag-and-drop. |
Panel |
---|
borderColor | darkred |
---|
bgColor | lightyellow |
---|
titleColor | white |
---|
borderWidth | 3 |
---|
titleBGColor | darkred |
---|
title | Trouble Shooting! |
---|
|
Queries show no Results!
On page generation the pages are added to the Lucene Index. This index allows documents to be found.
If your query is supposed to find documents recently added, try to reload the page. It depends on the overall performance of your system how long the indexing process takes. The speed of indexing is not in scope of projectdoc and is managed by your system administrator.
My Queries are Lacking Results!
Selection of property names and values is very strict. If you happen to add some fance HTML fragment instead of a simple value, the result may never match.
Problems usually arise if you copy paste values for document properties.
Two options here:
- Use the Confluence Source Editor and check what is really in there (recommended)
- Create a new table row and type in the content manually. Then erase the buggy row.
Info Box |
---|
There are many more macros provided by projectdoc! |
Info Box |
---|
There are many features provided by projectdoc! |
Content Layer |
---|
|
|