Summary of the content on the page No. 1
Mac OS X Server
Extending Your Wiki Server
For Version 10.5 Leopard
Summary of the content on the page No. 2
K © 2008 Apple Inc. All rights reserved. The owner or authorized user of a valid copy of Mac OS X Server software may reproduce this publication for the purpose of learning to use such software. No part of this publication may be reproduced or transmitted for commercial purposes, such as selling copies of this publication or for providing paid-for support services. Every effort has been made to ensure that the information in this manual is accurate. Apple Inc. is not responsible for prin
Summary of the content on the page No. 3
Contents 5 Preface: About This Guide 5 Getting Additional Information 7 Chapter 1: Customizing How the Wiki Looks 7 Theme File Structure Overview 9 Variant Theme File Structure Overview 10 Wireframe Theme File Structure Overview 12 Creating a Theme 13 Editing CSS Files 14 Editing Property List Files 14 About Property List Editor 15 About Property List Files 17 Changing General Theme Settings 18 Creating Sidebars 22 Overview of the Example Sidebars 23 Using the Example Sidebars 25 Adding Java
Summary of the content on the page No. 4
37 Chapter 3: Managing Wiki Content 37 Migrating Wiki Content From Other Websites 37 Backing Up the Wiki Server 39 Wiki File Structure Overview 40 Manually Editing Raw Content 41 Viewing a Wiki’s Administration Settings 44 Viewing a Page’s Metainformation 45 Managing Attachments 4 Contents
Summary of the content on the page No. 5
About This Guide This guide explains how to create custom themes, allow specific protocols, CSS styles, and HTML tags and attributes, and manage wiki content. The default Wiki Server configuration makes it easy for groups to collaborate and communicate. Users can create and edit wiki pages, tag and cross-reference material, upload files and images, add comments, and search content. This guide shows you how to customize and extend the wiki to suit your needs. For example, you’ll learn how to
Summary of the content on the page No. 6
For information about administering wikis, see Directory Help. You can view Directory Help by opening Directory (located in /Applications/Utilities/) and choosing Help > Directory Help. For information about using the wiki, see Wiki help. You can view Wiki help by clicking the Help link located at the bottom of any Apple Wiki page. 6 Preface About This Guide
Summary of the content on the page No. 7
Customizing How the Wiki Looks 1 This chapter describes how to customize a wiki’s appearance. You can use a wiki’s admin settings to do the following:  Change the wiki’s title  Change the wiki’s theme  Add a custom tag-search sidebar to the main page  Choose who can make comments and which comments are moderated  Create a podcast and integrate it with iTunes These settings are sufficient for most wikis. However, if you have special needs—for example, if you want to use a specific organizat
Summary of the content on the page No. 8
However, CSS files located in individual theme folders take precedence and override the settings in this folder. Individual theme folders are subfolders with a .wikitheme extension that are located within this folder: /Library/Application Support/Apple/WikiServer/Themes/ /Library/Application Support/Apple/WikiServer/Themes/ theme_name/ compressed/ screen.css /usr/share/collaboration/themes/ Imports theme_name/ screen_compressed.css If the theme has a /compressed subfolder, it imports the CSS f
Summary of the content on the page No. 9
Variant Theme File Structure Overview Prebuilt themes have several variants, which all share the same layout but might have different banners or color schemes. Shared CSS files are in the main theme’s folder, while variants have separate CSS files located in other folders. /usr/share/collaboration/themes/ theme_name.variant/ screen.css screen/ Imports Imports CSS file theme_name/ screen.css screen/ Imports CSS files For example, the block theme has its shared CSS files located in: /usr/share/c
Summary of the content on the page No. 10
Wireframe Theme File Structure Overview The wireframe theme is a good example theme to customize, because unlike the other built-in themes, its CSS files are all located in its main theme folder (in the /Library location and not in the /usr location). It was designed as a bare-bones theme, which you can easily add to without having to remove unwanted elements. /Library/Application Support/Apple/WikiServer/Themes/wireframe.wikitheme/ preview.png print.css screen.css theme.plist screen/ CSS fil
Summary of the content on the page No. 11
File or Folder Name Purpose screen/calendar.css Sets the colors for the web calendar. screen/comments.css Sets various appearance attributes (such as padding, borders, and positioning) for comment entry and display. screen/footer.css Sets footer attributes, such as the margin, padding, color, and font size. screen/forms.css Sets the margin for the search field. screen/general.css Sets general blog and wiki display attributes, such as the font size and color, background colors, heading margin
Summary of the content on the page No. 12
Creating a Theme The easiest way to create a theme is to take the existing wireframe theme, make a copy of it with permissions intact, and then customize the copy. If you edit the included themes instead of copying them to new themes, your edits may be overwritten later by a software update. To create a copy of the wireframe theme with permissions intact: 1 In Terminal, enter the following commands: $ cd /Library/Application\ Support/Apple/WikiServer/Themes/ $ sudo ditto wireframe.wikitheme/
Summary of the content on the page No. 13
6 Restart the web service by doing one of the following: Â Restart the server. Â In Server Preferences, click Web, move the slider to Off, and then to On. Â In Server Admin, open the disclosure triangle for your server, select Web, click Stop Web, and then click Start Web. Â Enter the following in Terminal: $ sudo serveradmin stop teams; sudo serveradmin start teams; If prompted, enter your administrator account password. Restarting the server and restarting web service can disrupt users, so s
Summary of the content on the page No. 14
Here are some published CSS guides:  CSS: The Definitive Guide, 3rd Edition, by Eric Meyer. O’Reilly Media, Inc. 2006.  CSS Mastery: Advanced Web Standards Solutions, by Andy Budd, Simon Collison, and Cameron Moll. Friends of ED. 2006. Editing Property List Files Every theme has a theme.plist file, which controls:  The name of the theme  Whether the theme is publicly available  The height and width of the banner  Sidebar properties such as the name, type and number of links, and sort ord
Summary of the content on the page No. 15
Property List Editor doesn’t show comments, so if you want to see the example sidebars provided in the wireframe’s theme.plist, you’ll need to open the theme.plist file in a text editor and remove the comment markers surrounding the example sidebars. About Property List Files The theme.plist file is structured like an XML file. If you understand XML, editing the theme.plist is straightforward. If not, read the following sections for basic editing information. About Property List Keys and
Summary of the content on the page No. 16
Here is the sidebars array in a plain text editor: sidebars sidebar keys and values sidebar keys and values Here is an example of an array with a single string: value Here is an example of an array with multiple strings: value value 2 About Comments The theme.plist file includes comments to help provide editing
Summary of the content on the page No. 17
Changing General Theme Settings The wireframe theme’s theme.plist includes keys and values for the following general settings: Key Default Value Possible Values Optional or Required Description bannerImageHeight 99 Any number, 0 or Optional The amount in pixels alloted to the more height of the banner image. Images you upload are scaled to this size. If you define bannerImageHeight but not bannerImageWidth, the width scales proportionally. This value affects the banner image’s height, not
Summary of the content on the page No. 18
Creating Sidebars If you haven’t created a sidebar before, it might be easier to customize an example sidebar to suit your needs. In the wireframe theme’s theme.plist file, there is a sidebars section that contains an array of sidebars you can customize: sidebars sidebar keys and values sidebar keys and values Understanding the Types of Sidebars There are several types of sidebars, each with a specific pu
Summary of the content on the page No. 19
Static Unique Keys Static sidebars list predefined URLs. “Useful Links” is an example static sidebar. Static sidebars have the following keys: Key Example Value Possible Values Optional or Required Description urls Not applicable An array of dictionary Required Because links include entries, each representing several values, such as a single link the name of the link and the URL itself, every link is represented by a dictionary entry. headerURL http://example.com/ Fully qualified URL Option
Summary of the content on the page No. 20
Key Example Value Possible Values Optional or Required Description snippet Click here to see your Any string Optional Used for the link’s tool tip. server’s homepage. To enable tool tips, comment out the following block in the theme’s grouphome. css file: .grouphome .snippet{ display:none; } Search Unique Keys Search sidebars list search results using tag-based or text-based searching. “What’s Hot” and “What’s New” are examples of search sidebars. Search sidebars have the following uniqu
