1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML>
<HEAD>
<LINK type="text/css" rel="stylesheet" href="http://incubator.apache.org/tuscany/stylesheets/default.css">
<LINK rel="SHORTCUT ICON" href="http://cwiki.apache.org/confluence/display/TUSCANY/$images/favicon.ico">
<TITLE>Tuscany cwiki Development Guideline : Apache Tuscany</TITLE>
<META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD>
<BODY onload="init()">
<TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://incubator.apache.org/tuscany/images/TuscanyLogoNEW_Text_120px_bg.jpg">
<TR>
<TD valing="top" align="left">
<A href="http://cwiki.apache.org/confluence/pages/viewpage.action?spaceKey=TUSCANY&title=$siteroot"><IMG src="http://incubator.apache.org/tuscany/images/TuscanyLogoNEW_Text_120px_bg.jpg" height="91" width="25" border="0"></A>
</TD>
<TD>
<A href="http://incubator.apache.org/tuscany/"><IMG src="http://incubator.apache.org/tuscany/images/TuscanyLogo.jpg" border="0"></A>
</TD>
<TD width="100%">
</TD>
<TD align="right">
<IMG src="http://incubator.apache.org/tuscany/images/apache-incubator-logo.png" border="0">
</TD>
<!-- Adds the edit page link to the top banner-->
<TD valign="bottom">
<DIV style="padding: 2px 10px; margin: 0px;">
<A href="http://cwiki.apache.org/confluence/pages/editpage.action?pageId=56590">
<IMG src="http://incubator.apache.org/tuscany/images/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A>
</DIV>
</TD>
</TR>
</TABLE>
<TABLE border="0" cellpadding="2" cellspacing="0" width="100%">
<TR class="topBar">
<TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%">
<A href="home.html" title="Apache Tuscany">Apache Tuscany</A> > <A href="home.html" title="Home">Home</A> > <A href="" title="Tuscany cwiki Development Guideline">Tuscany cwiki Development Guideline</A>
</TD>
<TD align="left" valign="middle" class="topBarDiv" nowrap="true">
<A href="http://mail-archives.apache.org/mod_mbox/ws-tuscany-user">User List</A> | <A href="http://mail-archives.apache.org/mod_mbox/ws-tuscany-dev">Dev List</A> | <A href="http://issues.apache.org/jira/browse/Tuscany">Issue Tracker</A>
</TD>
</TR>
</TABLE>
<TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF">
<TR>
<TD align="left" valign="top">
<DIV id="PageContent">
<DIV class="pagecontent">
<DIV class="wiki-content">
<P>The Apache Tuscany Project Website (<SPAN class="nobr"><A href="http://incubator.apache.org/tuscany" title="Visit page outside Confluence" rel="nofollow">http://incubator.apache.org/tuscany<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN>) content is authored collaboratively by the Tuscany community. The content authoring and publish takes place in the following steps:-</P>
<UL>
<LI>This authoring of content happens on the <B>Tuscany Space</B> of the Confluence based Apache Wiki - <SPAN class="nobr"><A href="home.html" title="Visit page outside Confluence" rel="nofollow">http://cwiki.apache.org/confluence/display/TUSCANY<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN>.</LI>
<LI>Content thus created is exported as html, at regular intervals to the Confluence based export site - <SPAN class="nobr"><A href="http://cwiki.apache.org/TUSCANY" title="Visit page outside Confluence" rel="nofollow">http://cwiki.apache.org/TUSCANY<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN>.</LI>
<LI>Finally the confluence based html content is further exported at regular intervals over to the project's public site <SPAN class="nobr"><A href="http://incubator.apache.org/tuscany" title="Visit page outside Confluence" rel="nofollow">http://incubator.apache.org/tuscany<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN>.</LI>
</UL>
<P>There is more information at the end of this page on how content is synchronized from the Wiki to the public site.</P>
<P>Since the Wiki content forms the backbone for the public website content, it is important that the community adheres to some community accepted common guidelines when authoring content on the Wiki, to help in consistency and maintainability of the content. The objective of this page is to record these guidelines.</P>
<H2><A name="TuscanycwikiDevelopmentGuideline-WikiContentAuthoringandOrganizationGuidelines%26nbsp%3B"></A>Wiki Content Authoring and Organization Guidelines </H2>
<P>The Apache Tuscany project consists of three subprojects - SCA, SDO and DAS each of which is implemented in C++ and Java. These subprojects and their implementations have different documentation and download pages. There is a lot of information that gets shared on the website related to all these projects and it is essential to have a clear structure to help ease the administration, modification and maintenance of the website. Here is a proposal for how the information on cwiki can be organized with this goal in mind.</P>
<P><SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=TUSCANY&title=Need%20to%20make%20sure%20community%20is%20in%20agreement%20before%20we%20make%20this%20the%20guideline%20-%20so,%20here%20is%20the%20proposal&linkCreation=true&fromPageId=56590" title="Create Page: Need to make sure community is in agreement before we make this the guideline - so, here is the proposal" class="createlink">Need to make sure community is in agreement before we make this the guideline - so, here is the proposal<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/plus.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN>.</P>
<H3><A name="TuscanycwikiDevelopmentGuideline-ContentStructure"></A>Content Structure</H3>
<P>Tuscany cwiki is divided into two <B>logical</B> spaces.</P>
<OL>
<LI><B>Tuscany General space:</B> this is where you will find general Tuscany information, for example community, blogs, documentation and downloads for Tuscany. The root of the pages under this category is 'General Info'. The pages under 'General Info' contains information like : Home, SCA Overview, SDO Overview, DAS Overview. All pages categorized under 'Genral Info' the use the same navigation menu.</LI>
<LI><B>Tuscany Subproject space:</B> There is a 'logical' space for each subproject under Tuscany. For example, SCA Java, SDO Java, SCA Native, etc. When under a subproject, you'll only find information about the subproject. Each subproject uses its own menu (which is similar for all subprojects) to navigate through pages for that subproject. This means navigation remains constant when traversing through pages of a subproject.</LI>
<LI><B>Tuscany Menus :</B> Another category of pages are the various 'Menus' that are used. These have been isolated as another sub-tree of content to help in independent organization of Menu options. Under this subtree titled 'Menus' is organized all the sets of Menu options that appear on the Navigation pane on the left.</LI>
</OL>
<H4><A name="TuscanycwikiDevelopmentGuideline-Wikitreestructure"></A>Wiki tree structure</H4>
<P>Tuscany</P>
<UL>
<LI>Home
<UL>
<LI>SCA Overview (general)
<UL>
<LI>SCA Java (subproject)<BR>
<IMG class="emoticon" src="http://cwiki.apache.org/confluence/images/icons/emoticons/lightbulb_on.gif" height="16" width="16" align="absmiddle" alt="" border="0"> You will find a similar structure as SCA Java under all other subprojects (SCA Native, SDO Java, DAS Java, ...)
<UL>
<LI><B>SCA Java Subproject Documentation Menu</B> - All publishable documentations are under this</LI>
<LI><B>SCA Java Releases</B> - All release download pages for the subproject are under this</LI>
<LI><B>SCA Java Work-in-progress</B> - This is place holder for work in progress. For example, discussion about new release, documentation in progress, etc. would all go under this category</LI>
</UL>
</LI>
<LI>SCA Native (subproject)</LI>
</UL>
</LI>
<LI>SDO Overview (general)
<UL>
<LI>SDO Java (subproject)</LI>
<LI>SDO Native (subproject)</LI>
</UL>
</LI>
<LI>DAS Overview (general)
<UL>
<LI>DAS Java (subproject)</LI>
<LI>DAS Native (subproject)</LI>
</UL>
</LI>
<LI>General Info (general) - holds information applicable to all projects. For example, Events, documentat/download, community, etc.</LI>
<LI>Menus - You will find all menus under here
<UL>
<LI>General - You will find general menu here</LI>
<LI>Subproject Menus - You will find subproject specific menus here</LI>
</UL>
</LI>
</UL>
</LI>
</UL>
<H3><A name="TuscanycwikiDevelopmentGuideline-Guidelines"></A>Guidelines</H3>
<OL>
<LI>Before adding any content to the wiki take a look at the content tree structure at <SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/pages/listpages-dirview.action?key=TUSCANY" title="Visit page outside Confluence" rel="nofollow">http://cwiki.apache.org/confluence/pages/listpages-dirview.action?key=TUSCANY<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN> and identify a node in the tree where the content could best fit. To start with you could identify if the content falls under general or under a specific subproject or under a specific implementation of a subproject. Then under this you could further categorize if the content is to do with 'Technical Documentation' or 'Release' and so on.</LI>
<LI>Having decided on a position for the content page in the content tree strucuture ensure that the 'Parent Page' is properly set to the identified position (page).</LI>
<LI>If any part of a content is likely to be reused under different contexts and hence in different pages, then abstract such reusable content into a separate page and include it in the various contexts (using the include macro) instead of duplicating the content across contexts.</LI>
<LI>Since all pages should have a relevant Navigation Menu when composing a page divide the page into two columns (under a section) with the Menus going into the first column and the page content going into the second column. Use the following as a template for all pages.
<DIV class="preformatted"><DIV class="preformattedContent">
<PRE>{section:border=false}
{column:width=15%}
{include: <enter the name an existing Menu page from the 'Menus' category of pages>}
{column}
{column:width=85%}
<<enter page content here>>
{column}
{section}
</PRE>
</DIV></DIV></LI>
<LI>If there are going to be a set of pages that are likely to be created with the same specific set of menus then a easy way of creating them as per the above template is to go and first create a template page at <SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/pages/templates/listpagetemplates.action?key=TUSCANY" title="Visit page outside Confluence" rel="nofollow">http://cwiki.apache.org/confluence/pages/templates/listpagetemplates.action?key=TUSCANY<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN> using the above snippet with approprieate Menu pages substituted. Subsequently when create a page go to <SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/pages/templates/listpagetemplates.action?key=TUSCANY" title="Visit page outside Confluence" rel="nofollow">http://cwiki.apache.org/confluence/pages/templates/listpagetemplates.action?key=TUSCANY<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN>and exercise the "Create page from template" option against the template just created. This will result in a new page with the appropriate sections and menus and the content can be right away filled in.</LI>
<LI>If a new set of Menu options are to be created, then create a menu page for this under the 'Menus' category. You can also choose to create a set of menu options reusing the existing Menu pages and 'including' them as required.</LI>
</OL>
<H2><A name="TuscanycwikiDevelopmentGuideline-Namingconvention"></A>Naming convention</H2>
<H1><A name="TuscanycwikiDevelopmentGuideline-HowtodeploytoconvertCofluenceNativetoApacheTuscanywebsite"></A>How to deploy to convert Cofluence Native to Apache Tuscany website</H1>
<P>We use an autoexport plugin that automatically converts Confluence's native, and dynamically generated content into a static HTML version that gets exported to the Tuscany website which is located at incubator.apache.org/Tuscany.</P>
<P><IMG src="tuscany-cwiki-development-guideline.data/WebsiteStructure.JPG" align="absmiddle" border="0"></P>
<P><B>Resources</B></P>
<UL>
<LI>Website SVN : <SPAN class="nobr"><A href="https://svn.apache.org/repos/asf/incubator/tuscany/site/site-publish/" title="Visit page outside Confluence" rel="nofollow">https://svn.apache.org/repos/asf/incubator/tuscany/site/site-publish/<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>
<LI>Exported website : Apache minutaur machine at -> /www/confluence-exports</LI>
<LI>Tuscany website : Apache minotaur machine at -> /www/incubator.apache.org/tuscany</LI>
</UL>
</DIV>
</DIV>
</DIV>
</TD>
</TR>
</TABLE>
<SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</SCRIPT>
<SCRIPT type="text/javascript">
_uacct = "UA-1174707-5";
urchinTracker();
</SCRIPT>
<DIV class="footer">
Copyright © 2003-2007, The Apache Software Foundation
</DIV>
</BODY>
</HTML>
|
