Apple Computer manual

M a c OS X Se r v er Extending Y our Wiki Ser v er F or V ers i on 1 0 .5 Leopard[...]

© 2008 Apple Inc . A ll 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 repr oduced or transmitted for commer cial purposes, such as selling copies of this publication or for pr oviding [...]

5 Pr eface: 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 Files 1 4 About Pr oper t y List Editor 1 5 About Pr [...]

3 7 Chapter 3: Manag ing Wiki Con tent 3 7 Migrating Wiki Content F rom Other W ebsites 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 M etainformation 45 Managing Attachments 4 Cont ents[...]

5 This guide explains ho w to creat e custom themes , allow specic prot ocols, CSS st yles , and HTML tags and attributes , and manage wiki content. The default Wik i Ser ver conguration makes it easy for gr oups to collaborate and communicate . Users can creat e and edit wik i pages, tag and cross-refer ence material, upload les and image[...]

6 Preface A bout This Guide F or information about administering wikis, see Direc tory H elp . Y ou can view Director y Help by opening Director y (located in /Applications/Utilitie s/) and choosing Help > Director y Help. F or information about using the wiki, see Wiki help. Y ou can vie w Wiki help by click ing the Help link located at the bot[...]

7 This chapter de scribes how to cust omize a wiki’ s appearance . Y ou can use a wik i ’ s admin settings to do the following: Change the wiki ’ s title  Change the wiki ’ s theme  Add a custom tag-sear ch sidebar to the main page  Choose who can make comments and which comments ar e moderated  Create a podcast and in tegrate it wi[...]

Howev er , CSS les located in individual theme folders take prec edence and override the settings in this folder . Individual theme folders are subf olders with a .wikitheme ex tension that are located within this folder: /Library/Application Suppor t/Apple/Wik iSer ver/Themes/ /Library/Application Suppor t/Apple/WikiSer ver/Themes/ compressed/ [...]

Chapter 1 Customizing Ho w the Wiki Looks 9 V ariant Theme File S tructure O verview Pr ebuilt themes have sev eral variants , which all share the same la yout but might hav e 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/c[...]

Wireframe Theme File S truc ture Overview The wireframe theme is a good example theme t o customize , because unlike the other built-in themes, its CSS les are all located in its main theme f older (in the /Librar y location and not in the /usr location). I t was designed as a bare-bones theme , which you can easily add to without ha ving to rem[...]

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 , an[...]

Creating a Theme The easiest wa y to create a theme is t o 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 cop ying them to new themes, your edits may be ov er written later by a software update . T o create a copy of the wirefr ame theme with per[...]

Chapter 1 Customizing Ho w the Wiki Looks 13 6 Restart the web ser vice by doing one of the following: Restart the ser ver .  In Ser ver Pr eference s, click W eb, move the slider to O , and then to On.  In Ser ver Admin, open the disclosure triangle for your server , select W eb , click Stop  W eb , and then click Star t W eb. Enter the f[...]

Here are some published CSS guides: Â CSS: The D enitive Guide , 3rd Edition, by Eric Meyer . O’Reilly Media, Inc. 2 006. Â CSS Mastery : A dvanced Web Standards Solutions , by Andy Budd , Simon Collison, and Cameron Moll. Friends of ED . 2006. Editing P roper ty List File s Every theme has a theme.plist le, which controls: The name of th[...]

Chapter 1 Customizing Ho w the Wiki Looks 15 Pr oper t y List Editor doesn ’t show comments , so if you wan t to see the example sidebars provided in the wirefr ame’ s theme.plist, you’ll need t o open the theme.plist le in a text editor and remo ve the comment markers surrounding the example sidebars. About Pr oper ty List Files The theme[...]

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 f or the following general settings: Key Default V alue P ossible V alues Optional or Required Description bannerImageHeight 99 Any number , 0 or more Optional The amount in pixels allot ed to the height of the[...]

Creating Sidebars If you hav en ’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 section that contains an array of sidebars you can cust omize: <key>sidebars</key> <array> <dict> sidebar keys and values [...]

Chapter 1 Customizing Ho w the Wiki Looks 19 Static Unique K eys 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 Ke ys 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 arr ay :  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 that 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 ar[...]

Chapter 1 Customizing Ho w the Wiki Looks 23 Using the Example Sidebars The wireframe theme ’ s theme.plist le includes several sidebar example s. All of these examples are commen ted out by default. Y ou’ll need to remo ve 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 wan t to comment out, do the following: a Add <!-- bef ore the <dict> tag of the sidebar you want to commen t out. F or sidebars, <dic t> tags are follo wed by the displa yName key . F or example, to comment out the “ What’ s Hot ” sidebar , you ’ d change this: <dict> <key>displayName[...]

Chapter 1 Customizing Ho w the Wiki Looks 25 Adding Ja v aScript and XSL File s The wiki ser ver suppor ts the use of custom Jav aScript and Ex tensible Stylesheet Language (XSL) les. JavaScript and XSL change the con tent you ’ re displaying , whereas CSS controls the pr esentation of con tent. For example , you use could use JavaScript or XS[...]

2 Restart the web ser vice by doing one of the following: Restart the ser ver .  In Ser ver Pr eference s, click W eb, move the slider to O , and then to On.  In Ser ver Admin, open the disclosure triangle for your server , select W eb , click Stop  W eb , and then click Star t W eb. Enter the f ollowing in T erminal:  $ sudo serveradmin[...]

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 t o www .apple.com, and changes the “O ther Wik is” link to point t o www .apple.com: Event.observe(window, 'load', function() { // add another header link (to apple.c[...]

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 generates XML c ontent, which is called context . [...]

Chapter 1 Customizing Ho w the Wiki Looks 29 3 Restart the web ser vice by doing one of the following: Restart the ser ver .  In Ser ver Pr eference s, click W eb, move the slider to O , and then to On.  In Ser ver Admin, open the disclosure triangle for your server , select W eb , click Stop  W eb , and then click Star t W eb. Enter the f[...]

30 This chapter de scribes how to enable s pecic protocols , CSS styles, and HTML tags and attributes. The default wiki ser ver setup simplies administration b y automatically remo ving potentially harmful protoc ols, CSS st yles, 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, creat e a plain text le named whitelist.plist in: /Library/Application Suppor t/Apple/Wik iSer ver/ The follo wing sections describe this example whitelist.plist in detail: <?xml version="1.0[...]

About the Cust om Whitelist’ s Struc ture The follo wing lines are required in the cust om whitelist: <?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 “ st yle ” attribute, add the “ st yle” attr[...]

<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. Howev er , a software update could change the allowed elemen ts in the built-in whitelist. Pr o[...]

Chapter 2 Allowing Specic P rotocols , CSS Styles, and HTML T ags and Attributes 35 Prot ocol 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-weigh t font-style HTML T ags and Attribute s Allowed in the Built-in Whitelist The built-in whitelist a[...]

Ta g Attributes node ol p pre q cite span strong table tbody tfoot th colspan, rows pan thead td colspan, rows pan tr u ul 36 Chapter 2 Allowing Specic P rotocols, CSS Styles, 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 wik i conten t. Migrating Wik i Cont ent F rom Other W ebsites AppleWikiImpor ter is a tool that can trav erse a website 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 administra tor 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 ser ver stores gr oup wik is 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 attachmen[...]

The Groups f older in the wik i data store includes the f ollowing 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 y ou edit wik i content. If you manually edit raw con tent, erase this ?[...]

Chapter 3 Managing Wiki Content 41 F or more information about A tomPub , see: W ebsite URL RFC 4287: The A tom Syndication F ormat atompub .org/rfc4287 .html RFC 5023: The A tom Publishing P rotocol tools.ietf .org/html/rfc5023 T o regenerate the index after editing ra w wiki content: 1 Delete /Library/Collaboration/Groups/ group_name /index.db . [...]

The metadata.plist le includes the f ollowing keys: Key Example V alue Description GUID 28C C6BE9-1 1C1-456C-A3B2-8FCF5 5 20A1DB Uniquely identies the wiki. This value must corre spond to the group record’ s GUID in the director y domain. T o view a group record's GUID , use W orkgroup Manager . For more information, see User Managemen[...]

Chapter 3 Managing Wiki Content 43 T o manually edit wik i administration settings: 1 Stop the web service by doing one of the following: In Ser ver Pr eference s, click W eb and move the slider to O .  In Ser ver Admin, open the disclosure triangle for your server , select W eb , and click  Stop Web . Enter the f ollowing in T erminal:  $[...]

6 Start the web ser vice by doing one of the following: In Ser ver Pr eference s, click W eb and move the slider to On.  In Ser ver Admin, open the disclosure triangle for your server , select W eb , and click  Start W eb. Enter the f ollowing in T erminal:  $ sudo serveradmin start teams; If prompted , enter y our administrator accoun t pass[...]

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/&[...]