Apple Computer Hardware manual

M a c OS X Se r v er Extending Y our Wiki Ser ver F or V ersi on 1 0.5 L eopard[...]

© 2008 Apple Inc. All rights reserved. K The owner or authorized user of a v alid copy of Mac OS X Ser v er software may reproduce this publication for the purpose of learning to use such software. No part of this publication may be reproduc ed or transmitted for commercial pur poses, such as selling copies of this publication or for pro viding pa[...]

5 Prefac e: About This Guide 5 Getting Additional Information 7 Chapter 1: C ustomizing How the Wiki Looks 7 Theme F ile Structure Over view 9 V ariant Theme File Structure Overview 1 0 Wireframe Theme File Structure Overview 1 2 Creating a Theme 13 Editing CSS F iles 1 4 Editing P roper ty List F iles 1 4 About Pr oper ty List Editor 1 5 About Pr [...]

3 7 Chapter 3: Managing Wiki Cont ent 3 7 Migrating Wiki Content F rom O ther Website s 3 7 Backing Up the Wiki Ser ver 39 Wiki File Structure Over view 40 Manually Editing Raw Conten t 4 1 Viewing a Wiki’ s Administration Settings 44 Viewing a Page ’ s Metainformation 45 Managing Attachments 4 Conten ts[...]

5 This guide explains how t o create cust om themes , allow specic prot ocols, CSS styles , and HTML tags and attributes , and manage wiki content. The default Wik i Server conguration makes it easy for groups t o collaborate and communicate . Users can creat e and edit wiki pages, tag and cross-ref erence material, upload les and images ,[...]

6 Preface About This Guide F or information about administering wikis, see Direc t or y Help . Y ou can view Director y Help by opening Directory (located in /Applications/Utilities/) and choosing Help > Director y Help . F or information about using the wiki, see Wiki help. Y ou can view Wiki help by clicking the Help link located at the bottom[...]

7 This chapter de scribes how to cust omize a wiki’ s appearanc e. Y ou 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 t o the main page  Choose who can make comments and which comments ar e moderated  Create a podcast and int egrate it with i[...]

However , CSS les located in individual theme folders take precedenc e and override the settings in this folder . Individual theme folders are subf olders with a .wikitheme ex tension tha t are located within this folder: /Library/Application Suppor t/Apple/WikiSer v er/Themes/ /Library/Application Suppor t/A pple/WikiSer ver/Themes/ compressed/[...]

Chapter 1 Customizing Ho w the Wiki Looks 9 V ariant Theme File S tructure O v erview Prebuilt theme s have sev eral variants , which all share the same layout but might have di erent banners or color schemes. Shared CSS les are in the main theme ’ s folder , while variants ha ve separate CSS le s located in other folders. /usr/share/col[...]

Wireframe Theme F ile Struc ture Overview The wireframe theme is a good example theme to cust omize, because unlike the other built-in themes, its CSS les are all located in its main theme f older (in the /Library location and not in the /usr location). I t was de signed as a bare-bones theme, which you can easily add to without ha ving to remov[...]

Chapter 1 Customizing Ho w the Wiki Looks 11 File or F older 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[...]

Creating a Theme The easiest wa y to create a theme is to take the existing wirefr ame theme, make a copy of it with permissions intact, and then customize the copy . If you edit the included themes instead of copying them t o new themes, your edits may be ov er written lat er by a software update. T o create a c opy of the wireframe theme with per[...]

Chapter 1 Customizing Ho w the Wiki Looks 13 6 Restart the web ser vice by doing one of the f ollowing: Restart the ser ver .  In Ser ver P references , click Web , mo ve the slider to O , and then to On.  In Ser ver A dmin, open the disclosure triangle for your server , select Web , click S top  W eb , and then click Star t Web . Enter th[...]

Here are some published CSS guides: Â CSS: The Denitive Guide, 3rd Edition, b y Eric Meyer . O’Reilly Media, Inc . 2006. Â CSS Mastery : Advanced Web Standards Solutions, b y Andy Budd, Simon Collison, and Cameron Moll. Friends of ED . 2 006. Editing P roper ty List F iles Every theme has a theme.plist le, which controls: The name of the [...]

Chapter 1 Customizing Ho w the Wiki Looks 15 Property List Editor doesn ’t show commen ts, so if you want to see the example sidebars provided in the wireframe ’ s theme.plist, you’ll need to open the theme.plist le in a text editor and remo ve the comment markers surrounding the example sidebars. About Pr oper ty List F iles The theme.pli[...]

Here is the sidebars array in a plain text editor: <key>sidebars</key> <array> <dict> sidebar keys and values </dict> <dict> sidebar keys and values </dict> </array> Here is an example of an array with a single string: <array> <string> value </string> </array> Here is an exampl[...]

Chapter 1 Customizing Ho w the Wiki Looks 17 Changing General Theme Settings The wireframe theme ’ s theme.plist includes keys and values for the f ollowing general settings: Key Default V alue Possible Values Optional or Required Description bannerImageHeight 99 Any number , 0 or more Optional The amount in pixels allot ed to the height of the b[...]

Creating Sidebars If you haven ’t created a sidebar bef ore, it might be easier to customize an example sidebar to suit your needs. In the wireframe theme ’ s theme.plist le , there is a sidebars sec tion that c ontains an array of sidebars you can customiz e: <key>sidebars</key> <array> <dict> sidebar keys and values[...]

Chapter 1 Customizing Ho w the Wiki Looks 19 Static Unique Ke ys Static sidebars list predened URLs. “Useful Links” is an example static sidebar . Static sidebars hav e the following keys: Key Example V alue P ossible V alues Optional or Required Description urls Not applicable An array of dictionary entries, each representing a single link [...]

Key Example V alue P ossible V alues Optional or Required Description snippet Click here to see y our server ’ s homepage. Any string Optional Used for the link’ s tool tip. T o enable tool tips, comment out the following block in the theme’ s grouphome. css le: .grouphome .snippet{ display:none; } Search Unique Key s Search sidebars list [...]

Chapter 1 Customizing Ho w the Wiki Looks 21 Key Example V alue P ossible V alues Optional or Required Description sort modiedDate, createdDate , title, author One or more of the following in the same array :  title  author  authorLongName  lastModiedAuthor  lastModiedAuthor LongName  createdDate  modiedDate  content  [...]

T ag Unique Key s T ag sidebars list wiki, blog , and mailing list entries tha t use a specic tag or set of tags. The most recen tly modied entries are listed rst. T ag sidebars have the f ollowing unique keys: Key Example V alue P ossible V alues Optional or Required Description tag hot A single string or several strings all in the same a[...]

Chapter 1 Customizing Ho w the Wiki Looks 23 Using the Example Sidebars The wireframe theme ’ s theme.plist le includes several sidebar examples . All of these examples are commen ted out by default. Y ou’ll need to remov e the comments marks if you want t o use the example sidebars as custom sidebars. If you don ’t add any custom sidebars[...]

5 F or each sidebar that you want t o comment out, do the following: a Add <!-- befor e the <dict> tag of the sidebar you want to commen t out. F or sidebars, <dict> tags are followed by the dis playName key . F or example, to comment out the “ Wha t’ s Hot ” sidebar , you ’ d change this: <dict> <key>displayName&[...]

Chapter 1 Customizing Ho w the Wiki Looks 25 Adding Ja vaScript and XSL F iles The wiki ser ver supports the use of custom Jav aScript and Extensible St ylesheet Language (XSL) les. JavaScript and XSL change the con tent you ’ re displaying , whereas CSS controls the pre sentation of cont ent. For example , you use could use JavaScript or XSL [...]

2 Restart the web ser vice by doing one of the f ollowing: Restart the ser ver .  In Ser ver P references , click Web , mo ve the slider to O , and then to On.  In Ser ver A dmin, open the disclosure triangle for your server , select Web , click S top  W eb , and then click Star t Web . Enter the f ollowing in T er minal:  $ sudo servera[...]

Chapter 1 Customizing Ho w the Wiki Looks 27 Jav aScript Example The follo wing example JavaScript function adds a header link next to the magnier button that points to www .apple.com, and changes the “O ther Wik is ” link to point to www .apple.com: Event.observe(window, 'load', function() { // add another header link (to apple.co[...]

28 Chapter 1 Customizing Ho w the Wiki Looks If you edit a copy of the default.x sl le, you must also make copies of all of the XSL les that include the original default.xsl le , and then change them to include the edited default.xsl le . Viewing Dynamic XML The wiki ser ver dynamically gener ates XML cont ent, which is called context .[...]

Chapter 1 Customizing Ho w the Wiki Looks 29 3 Restart the web ser vice by doing one of the f ollowing: Restart the ser ver .  In Ser ver P references , click Web , mo ve the slider to O , and then to On.  In Ser ver A dmin, open the disclosure triangle for your server , select Web , click S top  W eb , and then click Star t Web . Enter th[...]

30 This chapter de scribes how to enable s pecic protocols , CSS styles, and HTML tags and attribute s. The default wiki ser v er setup simplies administration by a utomatically removing potentially harmful protocols , CSS styles, and HTML tags and attributes. The wiki ser ver is capable of allowing all protocols , CSS st yles , and HTML tags[...]

Chapter 2 Allowing Specic P rotocols, CSS Styles, and HTML T ags and Attributes 31 Creating a C ustom Whitelist T o create a custom whit elist, create a plain text le named whitelist.plist in: /Library/Application Suppor t/Apple/WikiSer v er/ The follo wing sections describe this example whitelist.plist in detail: <?xml version="1.0&q[...]

About the Cust om Whitelist’ s Struc tur e The follo wing lines are required in the custom whit elist: <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple. com/DTDs/PropertyList-1.0.dtd"> <plist version="1.0"> <dict>[...]

Chapter 2 Allowing Specic P rotocols, CSS Styles, and HTML T ags and Attributes 33 F or example, to allow the use of the fon t-size style attribute, create the following block: <key>styles</key> <array> <string>font-size</string> </array> T o allow the HTML “ style” attribute, add the “ style” attribut[...]

<array> <string>src</string> <string>type</string> <string>width</string> <string>height</string> </array> </dict> About the Built-in Whitelist Y ou can ’t change the built-in whitelist. However , a software update could change the allowed elements in the built-in whit elist. Prot [...]

Chapter 2 Allowing Specic P rotocols, CSS Styles, and HTML T ags and Attributes 35 Protoc ol tel telnet vnc webcal xmpp CSS Styles Allow ed in the Built-in Whitelist The built-in whitelist allows the se CSS styles: Style text-decoration font-weight font-style HTML T ags and Attributes A llowed in the Built-in Whitelist The built-in whitelist all[...]

Ta g Attributes node ol p pre q cite span strong table tbody tfoot th colspan, rowspan thead td colspan, rowspan tr u ul 36 Chapter 2 Allowing Specic Protoc ols, CSS St yle s, and HTML T ags and Attributes[...]

3 7 This chapter de scribes how to manage wiki cont ent using tools and the command-line . Using tools and the command line allows y ou to migrate , back up, and edit raw wiki conten t. Migrating Wik i C onten t F rom Other W ebsites AppleWikiImpor ter is a tool tha t can traverse a w ebsite that has a page listing all other pages in the site , and[...]

T o manually back up the wiki, c opy the wiki data store with its permissions intact. F or example, to copy the wiki data store to a f older on a di erent volume , enter the following in T erminal and then authenticate as an administrat or when requested: sudo ditto /Library/Collaboration/ /Volumes/ volumename / foldername / If you created or ed[...]

Chapter 3 Managing Wiki Content 39 Wiki File Structure Over view By default, the wik i server stores gr oup wikis in /Librar y/Collaboration/Gr oups/. The illustration below sho ws group wiki les and folders. index.db metadata.plist /Library/Collaboration/Groups/ attachments/ page.html page.plist wiki/ group_name/ attachment_filename attachment_[...]

The Groups folder in the wiki data store include s the following critical wiki les and folders: File or F older Name Purpose group_name / Enabling web services for a group create s a folder with the group ’ s shor t name. group_name /index.db Automatically changed when you edit wiki conten t. If you manually edit raw cont ent, erase this le[...]

Chapter 3 Managing Wiki Content 41 F or more information about At omPub , see: W ebsite URL RFC 4287: The Atom S yndication Format atompub .org/rfc4287 .html RFC 5023: The Atom P ublishing Protoc ol tools.ietf.org/html/rfc5023 T o regenerat e the index after editing raw wiki cont ent: 1 Delete /Library/Collaboration/Groups/ group_name /index.db . T[...]

The metadata.plist le includes the f ollowing keys: Key Example V alue Description GUID 28CC6BE9-1 1C1-456C-A3B2-8FCF5 520A1DB Uniquely identie s the wiki. This value must corres pond to the group record’ s GUID in the directory domain. T o view a group record's GUID , use Workgroup Manager . For more information, see User Management a[...]

Chapter 3 Managing Wiki Content 43 T o manually edit wiki administration settings: 1 Stop the web service by doing one of the following: In Ser ver P references , click Web and mov e the slider to O .  In Ser ver A dmin, open the disclosure triangle for your server , select Web , and click  Stop Web . Enter the f ollowing in T er minal:  $[...]

6 Start the web ser vice by doing one of the f ollowing: In Ser ver P references , click Web and mov e the slider to On.  In Ser ver A dmin, open the disclosure triangle for your server , select Web , and click  Start W eb. Enter the f ollowing in T er minal:  $ sudo serveradmin start teams; If prompted , enter y our administrator account pas[...]

Key Example V alue Description tombstoned <true/>, <false/> Originally set to false, this is set to true when a page is temporarily deleted. If a page is permanently deleted, the entire page_uid .page/ folder is removed . uid groups/ group_name /wiki/ page_uid / Unique identier for the wiki page and its location. versioned <true/&[...]