Wiki source code of Getting Started
Version 45.1 by Ecaterina Moraru (Valica) on 2017/08/22
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
34.1 | 1 | Welcome to the XWiki "Get Started" page. This guide provides basic information on how to set up and use XWiki. Start by learning more about [[wikis>>enterprise:GettingStarted.WhatIsAWiki]]. |
 |
1.1 | 2 | |
| |
34.1 | 3 | XWiki's use cases are diverse: collaborative intranet, knowledge base, CMS, competitive intelligence, public debate, collaborative creation of school courses, web site creation, etc. Read more on [[what wikis can be used for>>enterprise:GettingStarted.WhatCanAWikiBeUsedFor]], [[what makes XWiki special>>enterprise:GettingStarted.WhatsSpecialAboutXWikiEnterprise]] and a [[second generation wiki>>platform:Main.SecondGenerationWiki]]. |
 |
9.1 | 4 | |
| |
33.2 | 5 | You can visit the [[references page>>xwiki:References.WebHome]] to see a list of varied projects based on XWiki. You can add your own project to the same page by filling in a short form. You can also go to the [[XWiki project homepage>>xwiki:Main.WebHome]] to see some of the companies that use XWiki or check out the [[testimonials page>>xwiki:References.Testimonials]] to view what our users have to say. |
| |
9.1 | 6 | |
| |
33.1 | 7 | = Basic information = |
| |
28.1 | 8 | |
| |
9.1 | 9 | |
| |
33.1 | 10 | The first thing you want to do is make sure you've [[downloaded>>xwiki:Download.WebHome]] and [[installed XWiki>>platform:AdminGuide.Installation]]. For first time XWiki users and for users who wish to quickly try out XWiki we recommend installing the [[standalone distribution>>platform:AdminGuide.InstallationStandalone]]. You can also use the [[playground>>playground:Main.WebHome]] if you're not looking to install XWiki from scratch. |
| |
9.1 | 11 | |
| |
33.1 | 12 | (% class="row" %) |
| 13 | ((( | ||
| 14 | (% class="col-xs-12 col-md-6" %) | ||
| 15 | ((( | ||
 |
30.2 | 16 | Then, as you log in to your wiki, the first thing you see is the wiki homepage. |
| |
30.1 | 17 | |
| |
34.1 | 18 | [[image:1.png||style="vertical-align: middle;"]] XWiki is divided into Wikis and Pages. Inside a wiki, you can create a hierarchy of pages, by creating pages inside other pages. This feature is called [[Nested Pages>>platform:Features.ContentOrganization]]. From this area you can [[add new pages>>platform:Features.DocumentLifecycle]] by clicking the "+" button. |
| |
33.3 | 19 | |
| |
33.1 | 20 | [[image:2.png||style="vertical-align: middle;"]] Whenever you want to [[modify a page>>platform:Features.PageEditing]], click on the pen edit button, make your changes and save the page. The modified page now replaces the previous version. Each version of the page is stored in the [[page history>>platform:Features.VersionControl]] and can be reverted to if needed. More page actions, such as Administer, Copy, Rename, Delete, Export, are also available from the last two menus on the right. |
| |
9.1 | 21 | |
| |
33.1 | 22 | [[image:3.png||style="vertical-align: middle;"]] From the upper right corner you may click on your [[profile>>extensions:Extension.User Profile Application]], or the notifications menu. |
| |
9.1 | 23 | |
| |
33.1 | 24 | [[image:4.png||style="vertical-align: middle;"]] By expanding the drawer menu on the right you can access you profile or go to the [[wiki administration>>extensions:Extension.Administration Application]]. You can also access the wiki, page or user [[indexes>>extensions:Extension.Index Application]], as well as add a new wiki. |
| |
9.1 | 25 | |
| |
33.1 | 26 | [[image:5.png||style="vertical-align: middle;"]] The [[dashboard>>extensions:Extension.Dashboard Application]] allows users to customize pages by adding gadgets. You can edit/modify the dashboard by editing the page which contains the dashboard. The default dashboard has: |
| |
9.1 | 27 | |
| |
31.1 | 28 | ((( |
| 29 | * A welcome message | ||
| |
28.1 | 30 | * The pages macro |
| 31 | * A tags cloud | ||
| |
18.1 | 32 | * The ability to send messages |
| |
31.1 | 33 | * The activity stream |
| 34 | ))) | ||
| |
9.1 | 35 | |
| |
34.1 | 36 | [[image:6.png||style="vertical-align: middle;"]] Lateral menus are handled using panels. A [[panel>>GettingStarted.ChangingTheLogoAndThePanels]] is a widget you can see on the left and right of every page of your wiki in the standard version of XWiki. By default you will see a small sized Applications panel on the left and medium sized panels on the right. |
| |
9.1 | 37 | |
| |
33.1 | 38 | [[image:7.png||style="vertical-align: middle;"]] The tabbed area at the bottom of the page features by default [[comments>>platform:Features.DocumentLifecycle||anchor="HComments"]], [[attachments>>platform:Features.Attachments]], [[page history>>platform:Features.VersionControl]], page information. |
| 39 | ))) | ||
| |
18.1 | 40 | |
| |
33.1 | 41 | (% class="col-xs-12 col-md-6" %) |
| 42 | ((( | ||
| 43 | [[image:Homepage.PNG>>attach:Homepage.PNG]] | ||
| 44 | ))) | ||
| 45 | ))) | ||
| |
18.1 | 46 | |
| |
34.1 | 47 | To see the complete list of features go to the [[features page>>enterprise:Main.Features]]. More information on the first steps with XWiki can be found on [[this page>>enterprise:GettingStarted.FirstStepsWithXWikiEnterprise]]. |
| |
9.1 | 48 | |
| |
35.1 | 49 | {{warning}} |
| |
33.1 | 50 | If you need more help with your wiki or you'd like to get in touch with the community please visit the [[support page>>xwiki:Main.Support]]. There you'll find more information on: |
| 51 | * [[Community support>>xwiki:Main.Support||anchor="HCommunitySupport"]] | ||
| 52 | * [[Professional support>>xwiki:Main.Support||anchor="HProfessionalSupport"]] | ||
| |
35.1 | 53 | {{/warning}} |
| |
33.1 | 54 | |
| 55 | (% class="row cards" %) | ||
| 56 | ((( | ||
| 57 | (% class="col-xs-12 col-md-6 cards-container" %) | ||
| 58 | ((( | ||
| 59 | {{html clean="false"}} | ||
| 60 | <div class="card card2" style="border: 0;"> | ||
| 61 | <div class="card-body"> | ||
| 62 | {{/html}} | ||
| 63 | |||
| 64 | (% style="margin-top: 0" %) | ||
| 65 | == If you're an Administrator == | ||
| 66 | |||
| |
31.1 | 67 | If you're using the Jetty/HSQLDB package, before you perform admin actions, you will need to log in using the following credentials: |
| |
9.1 | 68 | {{code}}Username: Admin |
| 69 | Password: admin{{/code}} | ||
 |
12.1 | 70 | We strongly recommend you change the Admin's password to a secret one as soon as you can. |
| |
31.1 | 71 | Otherwise, when you install XWiki from scratch, you are asked to register your own user which will be the owner of the wiki. |
| |
9.1 | 72 | |
| |
33.1 | 73 | The [[XWiki Platform>>platform:Main.WebHome]] provides general information for admins that need to customize their wiki application (authentication, DB, performance tuning, etc.). Everything you want to know about administrating XWiki, from installation to backups is available in the [[Administrator's Guide>>platform:AdminGuide.WebHome]]: |
| |
9.1 | 74 | |
| |
33.1 | 75 | * Discover how to [[create users and groups>>platform:Features.UsersAndGroupsManagement]] and [[handle rights on your wiki>>platform:Features.RightsManagement]]. |
| 76 | * Learn how to customize the look and feel of the wiki ([[skin>>platform:AdminGuide.Skins]], [[color themes>>extensions:Extension.Color Theme Application]], [[panels>>extensions:Extension.Panels Application]], etc.) | ||
| |
9.1 | 77 | * See how you can backup your wiki, import XAR files to the wiki and much more. |
| |
33.1 | 78 | {{html clean="false"}} |
| 79 | </div> | ||
| 80 | </div>{{/html}} | ||
| 81 | ))) | ||
| |
9.1 | 82 | |
| |
33.1 | 83 | (% class="col-xs-12 col-md-6 cards-container" style="border-left: 1px solid #e6e6e6" %) |
| 84 | ((( | ||
| |
33.6 | 85 | (% class="col-xs-12" %) |
| 86 | ((( | ||
| |
33.1 | 87 | {{html clean="false"}} |
| 88 | <div class="card card2" style="border: 0;"> | ||
| 89 | <div class="card-body"> | ||
| 90 | {{/html}} | ||
| |
9.1 | 91 | |
| |
33.1 | 92 | (% style="margin-top: 0" %) |
| 93 | == If you're a Developer == | ||
| |
9.1 | 94 | |
| |
33.1 | 95 | XWiki is also a second generation wiki. You can build simple applications, extend the platform with custom plugins, or even build complex Web applications. |
| 96 | |||
| 97 | XWiki's powerful programming features are documented in the [[Developer's Guide>>platform:DevGuide.WebHome]]. A number of applications are built-in, such as the Blog. Additional applications, macros and other extensions are available on the [[Extensions wiki>>extensions:Main.WebHome]]. The documentation for the [[XWiki Rendering>>rendering:Main.WebHome]] has a [[dedicated wiki>>rendering:Main.WebHome]]. | ||
| 98 | |||
| 99 | For documentation related to contributing to the XWiki project, visit the [[XWiki Development Zone>>dev:Main.WebHome]]. | ||
| 100 | |||
| 101 | {{html clean="false"}} | ||
| 102 | </div> | ||
| 103 | </div> | ||
| 104 | {{/html}} | ||
| 105 | ))) | ||
| 106 | ))) | ||
| |
33.6 | 107 | ))) |
