diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb index ad7b57a..4d969f6 100644 --- a/app/helpers/application_helper.rb +++ b/app/helpers/application_helper.rb @@ -904,6 +904,9 @@ module ApplicationHelper def page_title (@page ? @page.name + ' - ' : '') + (profile ? profile.short_name + ' - ' : '') + + (@topic ? @topic.title + ' - ' : '') + + (@section ? @section.title + ' - ' : '') + + (@toc ? _('Online Manual') + ' - ' : '') + environment.name + (@category ? "→ #{@category.full_name}" : '') end diff --git a/app/views/doc/_path.html.erb b/app/views/doc/_path.html.erb index 63b6875..62a0f45 100644 --- a/app/views/doc/_path.html.erb +++ b/app/views/doc/_path.html.erb @@ -1,6 +1,6 @@
<%= _('You are here:') %> - <%= link_to _('Documentation'), doc_path %> + <%= link_to _('Manual'), doc_path %> <% if @section %> » <%= link_to @section.title, doc_section_path(@section.id) %> <% end %> diff --git a/app/views/doc/_toc.html.erb b/app/views/doc/_toc.html.erb index 4d18e34..4cb2a06 100644 --- a/app/views/doc/_toc.html.erb +++ b/app/views/doc/_toc.html.erb @@ -1,5 +1,5 @@
-

<%= _('On-line documentation') %>

+

<%= _('Manual sections') %>

<%= _('Documentation') %> + title="<%= _('Manual') %>"><%= _('Manual') %>
diff --git a/doc/noosfero/cms/writing-advanced-article.textile b/doc/noosfero/cms/writing-advanced-article.textile index 346ce07..a23862c 100644 --- a/doc/noosfero/cms/writing-advanced-article.textile +++ b/doc/noosfero/cms/writing-advanced-article.textile @@ -1,4 +1,4 @@ -h1. Write an advanced article (inserting images and links) +h1. Writing an advanced article (inserting images, links, videos and audio) p. _You can add images and links to the articles created on the system to make it more interesting._ @@ -6,6 +6,7 @@ p. _You can add images and links to the articles created on the system to make * "Description":#Description ** "Inserting links":#InsertingLinks ** "Inserting images":#InsertingImages +** "Inserting videos and audio":#InsertingVideosAudio * "Related topics":#RelatedTopics h2(#HowAccess). How to access @@ -22,7 +23,7 @@ h3(#InsertingLinks). Inserting links ## *Link URL:* fill in with the link address ## *Target:* choose waht will happen when one person click on the link, if it will open in the same window or in a new one. ## *Title:* fill in what will be displayed when a person pass mouse over the link. - !=/images/doc/advanced-article-popup-inserir-link.en.png(Insert link popup on an article)! + !=/images/doc/advanced-article-popup-insert-link.en.png(Insert link popup on an article)! # After filling in the form, click on "Insert" and the link will be inserted on article. !=/images/doc/advanced-article-created-link.en.png(Created link on an article)! @@ -44,6 +45,13 @@ p. When creating/editing an article, you will see a box in the right side. ### Using your mouse, click and drag the image to the part of the text where it will be inserted. !=/images/doc/advanced-article-archives-list.en.png(Archives list when writing an article)! +h3(#InsertingVideosAudio). Inserting videos and audio + +# Click on "HTML" button !=/images/doc/advanced-article-insert-html.en.png(Insert html on an article)! +# Insert the code of the video or audio an click on "Update" !=/images/doc/advanced-article-popup-insert-html.en.png(Insert html popup on an article)! +# You will see a square with a "play" image on your text !=/images/doc/advanced-article-created-object.en.png(Created object on an article)! +# After clicking on "Save" button, the video or audio will be displayed on your text. + h2(#RelatedTopics). Related topics * "Writing an article":/doc/cms/writing-article diff --git a/doc/noosfero/community/accepting-members.textile b/doc/noosfero/community/accepting-members.textile new file mode 100644 index 0000000..a6f98f2 --- /dev/null +++ b/doc/noosfero/community/accepting-members.textile @@ -0,0 +1,27 @@ +h1. Accepting new members + +p. _If a community is moderated, the administrator/moderator needs to approve the requests of new members._ + +* "How to access":#HowAccess +* "Description":#Description +* "Related topics":#RelatedTopics + +h2(#HowAccess). How to access + +# Find your user menu on top bar: !=/images/doc/system-homepage-top-menu.en.png(Top menu)! +# In user menu, click on Control Panel: !=/images/doc/menu-control-panel.en.png(Control panel on menu)! +# Then, click on "Manage my groups" button: !=/images/doc/control-panel-manage-groups.en.png(Manage groups in control panel)! +# You will see the list of groups (communities/enterprises) that you are a member. The groups that you can manage are listed with a link "Manage". Assuming that you are a community administrator, click on "Manage" link. !=/images/doc/groups-list-with-manage-community.en.png(Groups list with permission to manage enterprise)! + +h2(#Description). Description + +# If the community has pending requests, you will see a box with the list of pending tasks on your control panel. In order to accept or deny, you should click on "Process requests" button + !=/images/doc/community-control-panel-with-tasks.en.png(Community control panel with pending tasks)! +# If you want to accept, choose the option "Accept". You also need to choose wich roles the new member should have. Each role has some permissions, that are defined by the environment administrator. + !=/images/doc/tasks-list-membership-request.en.png(Community tasks list)! + +h2(#RelatedTopics). Related topics + +* "Creating a community":/doc/community/creating-community +* "Joining a community":/doc/community/joining-community + diff --git a/doc/noosfero/community/creating-community.textile b/doc/noosfero/community/creating-community.textile new file mode 100644 index 0000000..8cc41ac --- /dev/null +++ b/doc/noosfero/community/creating-community.textile @@ -0,0 +1,28 @@ +h1. Creating a community + +p. _You can create communities to interact to others users_ + +* "How to access":#HowAccess +* "Description":#Description +* "Related topics":#RelatedTopics + +h2(HowAccess). How to access + +# Find you user menu on top bar: !=/images/doc/system-homepage-top-menu.en.png(Top menu)! +# In user menu, click on Control Panel !=/images/doc/menu-control-panel.en.png(Control panel on menu)! +# Then, click on "Manage my groups": !=/images/doc/control-panel-manage-groups.en.png(Manage groups in control panel)! + +h2(#Description). Description + +# Find the button "Create a new community" and click on it. !=/images/doc/groups-list-with-create-community.en.png(Groups list)! +# You will see a form to be filled with the community information. !=/images/doc/community-creation-form.en.png(Form for creation of a community)! +## *Name:* Fill in with the name of the community you want to create. +## *Tag list:* Fill in with tags. Tags are keywords or terms associated to your community. +## *Image:* Insert a picture. It will be the image of your community. Click on "File..." and choose the image in your computer. The image must have a maximum of 500Kb and should be .jpg , .gif or .png. +## *New members must be approved:* You should choose if the community should be moderated. Choosing the first option, a moderator needs to approve when a person asks to join the community. Choosing the second option, no moderation is needed. +## After filling the fields, click on "Create" button. +# If allowed by the environment, the community will be already created. Otherwise, the environment administrator will need to approve/deny the new community. + +h2(#RelatedTopics). Related topics + +* "Login into the system":/doc/user/login diff --git a/doc/noosfero/community/index.textile b/doc/noosfero/community/index.textile new file mode 100644 index 0000000..7767a2a --- /dev/null +++ b/doc/noosfero/community/index.textile @@ -0,0 +1 @@ +h1. Community features diff --git a/doc/noosfero/community/invite-contacts.textile b/doc/noosfero/community/invite-contacts.textile new file mode 100644 index 0000000..b770096 --- /dev/null +++ b/doc/noosfero/community/invite-contacts.textile @@ -0,0 +1,34 @@ +h1. Inviting contacts from e-mail + +p. _If you are a community administrator, you can invite e-mail contacts to join your community. If the e-mail is registered on the system, the user will receive an invitation through the system. If it is not registered, the user will receive an invitation on his e-mail._ + +* "How to access":#HowAccess +* "Description":#Description +* "Related topics":#RelatedTopics + +h2(#HowAccess). How to access + +# Find your user menu on top bar: !=/images/doc/system-homepage-top-menu.en.png(Top menu)! +# In user menu, click on Control Panel: !=/images/doc/menu-control-panel.en.png(Control panel on menu)! +# Then, click on "Manage my groups" button: !=/images/doc/control-panel-manage-groups.en.png(Manage groups in control panel)! +# You will see the list of groups (communities/enterprises) that you are a member. The groups that you can manage are listed with a link "Manage". Assuming that you are a community administrator, click on "Manage" link. !=/images/doc/groups-list-with-manage-community.en.png(Groups list with permission to manage enterprise)! + +h2(#Description). Description + +# In community control panel, click on "Manage members" !=/images/doc/community-control-panel-manage-members.en.png(Manage members in control panel)! +# You will see the members list of community and the invitation button. Click on the button. + !=/images/doc/community-members-with-invitation-button.en.png(Community's members list)! +# You can invite your contacts manually inserting their e-mails or importing the e-mails from your e-mail contacts. +** *Manually*: Choose the option "Manually" and click on "Next" !=/images/doc/community-manually-invitation-step-1.en.png(Manually invitation for community. Step 1)! +*** Type the e-mail adresses in the first field. You should type only one e-mail in each line. +*** Clicking on "Personalize invitation mail", you can edit the text that will be sent. Then, click on "Invite my friends" !=/images/doc/community-manually-invitation-step-2.en.png(Manually invitation for community. Step 2)! +** *Importing*: Choose one of the other options to import you contacts from your e-mail. Fill in the fields with the username and password you use to access your e-mail and click on "Next". !=/images/doc/community-import-invitation-step-1.en.png(Import invitation for community. Step 1)! +*** You can type e-mail adresses in the first field, only one e-mail in each line. +*** You will also see your list of e-mails. Check the e-mails that you want to send an invitation. +*** Clicking on "Personalize invitation mail", you can edit the text that will be sent. Then, click on "Invite my friends" !=/images/doc/community-import-invitation-step-2.en.png(Import invitation for community. Step 2)! + +h2(#RelatedTopics). Related topics + +* "Creating a community":/doc/community/creating-community +* "Joining a community":/doc/community/joining-community +* "Accepting members":/doc/community/accepting-members diff --git a/doc/noosfero/community/joining-community.textile b/doc/noosfero/community/joining-community.textile new file mode 100644 index 0000000..564502a --- /dev/null +++ b/doc/noosfero/community/joining-community.textile @@ -0,0 +1,23 @@ +h1. Joining a community + +p. _You can be part of a community and interact with its others members. To do that, you can join a community, as explained below._ + +* "How to access":#HowAccess +* "Description":#Description +* "Related Topics":#RelatedTopics + +h2(#HowAccess). How to access + +p. To join a community, first you need to access its page. Enter the community address on address bar or search for the community in the system and click to view it. + +p. To learn how you can find community in the system, read: "Finding communities":/doc/navigation/searching-communities. + +h2(#Descriptio). Description + +# In community's page, click on "+ Join" button below community's image. !=/images/doc/joining-community-button.en.png(Community with join button)! +# After clicking on "Yes, I want to join" button, you will already be member of the community if it is not moderated. !=/images/doc/join-community-confirmation.en.png(Confirmation after asking to join a community)! +# If the community is moderated, the administrator will need to approve your request before you start interacting. + +h2(#RelatedTopics). Related topics + +* "Finding communities":/doc/navigation/searching-communities diff --git a/doc/noosfero/community/moderating-articles.textile b/doc/noosfero/community/moderating-articles.textile new file mode 100644 index 0000000..c821b64 --- /dev/null +++ b/doc/noosfero/community/moderating-articles.textile @@ -0,0 +1,32 @@ +h1. Moderating articles + +p. _Community's members can publish articles on community. If the community is moderated, the administrator/moderator needs to approve or deny the publication._ + +* "How to access":#HowAccess +* "Description":#Description +* "Related topics":#RelatedTopics + +h2(#HowAccess). How to access + +# Find your user menu on top bar: !=/images/doc/system-homepage-top-menu.en.png(Top menu)! +# In user menu, click on Control Panel: !=/images/doc/menu-control-panel.en.png(Control panel on menu)! +# Then, click on "Manage my groups" button: !=/images/doc/control-panel-manage-groups.en.png(Manage groups in control panel)! +# You will see the list of groups (communities/enterprises) that you are a member. The groups that you can manage are listed with a link "Manage". Assuming that you are a community administrator, click on "Manage" link. !=/images/doc/groups-list-with-manage-community.en.png(Groups list with permission to manage enterprise)! + +h2(#Description). Description + +# If the community has pending requests, you will see a box with the list of pending tasks on your control panel. In order to accept or deny, you should click on "Process requests" button + !=/images/doc/community-control-panel-with-approval-task.en.png(Community control panel with pending tasks)! +# You will see the tasks list. !=/images/doc/tasks-list-approval-request.en.png(Community tasks list)! +## If you want to accept, choose the option "Accept". If you want to ignore the request, choose "Ignore". +## *Name for publishing*: When an article is approved, it will be listed as content of the community. If you think the article should have its original name, leave this field blank. If you want to change it, fill in with the name you want. +## *Choose the folder where the article must be published*: You can choose the folder where the article will be listed. +## *Highlight this article*: If the community is the news source of the environment, you can check this option to highlight the article on environment's homepage. +## *Comment for author*: The text written here will be sent to the requestor after your decision. + +After clicking on button "Ok!", your decision will be processed. If you accepted the article, it will be listed as community's content. + +h2(#RelatedTopics). Related topics + +* "Creating a community":/doc/community/creating-community +* "Joining a community":/doc/community/joining-community diff --git a/doc/noosfero/index.textile b/doc/noosfero/index.textile index 5c1ed51..1059890 100644 --- a/doc/noosfero/index.textile +++ b/doc/noosfero/index.textile @@ -1,8 +1,8 @@ -h1. Noosfero online documentation +h1. Noosfero online manual -This is the Noosfero online documentation. In these pages you will find useful +This is the Noosfero online manual. In these pages you will find useful information on how to use Noosfero, manage a Noosfero environment and customize Noosfero in several ways. -To display documentation about a given topic, first choose a section in the +To display the manual about a given topic, first choose a section in the left menu, and then choose a topic within the section. diff --git a/doc/noosfero/user/editing-person-info.textile b/doc/noosfero/user/editing-person-info.textile index f779394..104c94a 100644 --- a/doc/noosfero/user/editing-person-info.textile +++ b/doc/noosfero/user/editing-person-info.textile @@ -17,10 +17,9 @@ h2(#Description). Description # You will see a form with your information and settings. This will be explained in parts ## *General information:* Fill in with your data !=/images/doc/person-edit-profile-info-general-informationen.en.png(General information when editing person profile info)! ## *Change picture:* Insert or change your picture. Click on"File…" and choose the image in your computer. The image must have a maximum of 500Kb e be _.jpg_ , _.gif_ or _.png_ . !=/images/doc/person-edit-profile-info-change-picture.en.png(Change picture when editing person profile info)! -## *Privacy options:* Choose if your profile will be public or private. When a profile is private, the users that are not friends and that tries to view the profile or some of its contents will be redirected to a page that display only general information. - !doc/person-edit-profile-privacy-options.en.png(Privacy options when editing enterprise profile info)! -## *Categories:* If enabled in the system, you can choose the categories that the person will have. - !doc/person-edit-profile-categories.en.png(Categories when editing person profile info)! +## *Privacy options:* Choose if your profile will be public or private. When a profile is private, the users that are +not friends and that tries to view the profile or some of its contents will be redirected to a page that display only general information. !=/images/doc/person-edit-profile-privacy-options.en.png(Privacy options when editing enterprise profile info)! +## *Categories:* If enabled in the system, you can choose the categories that the person will have. !=/images/doc/person-edit-profile-categories.en.png(Categories when editing person profile info)! # Then, click on "Save" button an the profile will be updated. h2(#RelatedTopics). Related topics diff --git a/doc/noosfero/user/invite-contacts.textile b/doc/noosfero/user/invite-contacts.textile new file mode 100644 index 0000000..2fb433a --- /dev/null +++ b/doc/noosfero/user/invite-contacts.textile @@ -0,0 +1,31 @@ +h1. Inviting contacts from e-mail + +p. _You can invite e-mail contacts to be your friend on the system. If the e-mail is registered on the system, the user will receive an invitation through the system. If it is not registered, the user will receive an invitation on his e-mail._ + +* "How to access":#HowAccess +* "Description":#Description +* "Related topics":#RelatedTopics + +h2(#HowAccess). How to access + +# Find your user menu on top bar: !=/images/doc/system-homepage-top-menu.en.png(Top menu)! +# In user menu, click on Control Panel: !=/images/doc/control-panel-menu.en.png(Control panel menu)! +# Then, click on "Manage friends" !=/images/doc/manage-friends.en.png(Manage Friends)! + +h2(#Description). Description + +# You will your list of friends and the invitation button. Click on the button. + !=/images/doc/user-friends-with-invitation-button.en.png(User's friends list)! +# You can invite your contacts manually inserting their e-mails or importing the e-mails from your e-mail contacts. +** *Manually*: Choose the option "Manually" and click on "Next" !=/images/doc/user-manually-invitation-step-1.en.png(Manually invitation for user. Step 1)! +*** Type the e-mail adresses in the first field. You should type only one e-mail in each line. +*** Clicking on "Personalize invitation mail", you can edit the text that will be sent. Then, click on "Invite my friends" !=/images/doc/user-manually-invitation-step-2.en.png(Manually invitation for user. Step 2)! +** *Importing*: Choose one of the other options to import you contacts from your e-mail. Fill in the fields with the username and password you use to access your e-mail and click on "Next". !=/images/doc/user-import-invitation-step-1.en.png(Import invitation for user. Step 1)! +*** You can type e-mail adresses in the first field, only one e-mail in each line. +*** You will also see your list of e-mails. Check the e-mails that you want to send an invitation. +*** Clicking on "Personalize invitation mail", you can edit the text that will be sent. Then, click on "Invite my friends" !=/images/doc/user-import-invitation-step-2.en.png(Import invitation for user. Step 2)! + +h2(#RelatedTopics). Related topics + +* "Accepting friends":/doc/user/accepting-friends +* "Removing friends":/doc/user/removing-friends diff --git a/doc/noosfero/user/joining-community.textile b/doc/noosfero/user/joining-community.textile deleted file mode 100644 index 564502a..0000000 --- a/doc/noosfero/user/joining-community.textile +++ /dev/null @@ -1,23 +0,0 @@ -h1. Joining a community - -p. _You can be part of a community and interact with its others members. To do that, you can join a community, as explained below._ - -* "How to access":#HowAccess -* "Description":#Description -* "Related Topics":#RelatedTopics - -h2(#HowAccess). How to access - -p. To join a community, first you need to access its page. Enter the community address on address bar or search for the community in the system and click to view it. - -p. To learn how you can find community in the system, read: "Finding communities":/doc/navigation/searching-communities. - -h2(#Descriptio). Description - -# In community's page, click on "+ Join" button below community's image. !=/images/doc/joining-community-button.en.png(Community with join button)! -# After clicking on "Yes, I want to join" button, you will already be member of the community if it is not moderated. !=/images/doc/join-community-confirmation.en.png(Confirmation after asking to join a community)! -# If the community is moderated, the administrator will need to approve your request before you start interacting. - -h2(#RelatedTopics). Related topics - -* "Finding communities":/doc/navigation/searching-communities diff --git a/features/online_documenation.feature b/features/online_documenation.feature deleted file mode 100644 index 68adf71..0000000 --- a/features/online_documenation.feature +++ /dev/null @@ -1,27 +0,0 @@ -Feature: online documentation - As a user - I want to read the documentation - So that I know how to do something in Noosfero - - Scenario: initial page of online documentation - When I go to /doc - Then I should see "Noosfero online documentation" - - Scenario: displaying index content - When I go to /doc - Then I should see "User features" - And I should see "Content Management" - - Scenario: displaying section - When I go to /doc - And I follow "User features" - Then I should see "Accepting friends" - And I should see "Commenting" - - Scenario: displaying topic - When I go to /doc - And I follow "User features" - And I follow "Commenting" - Then I should see "How to access" - - diff --git a/features/online_manual.feature b/features/online_manual.feature new file mode 100644 index 0000000..7116eea --- /dev/null +++ b/features/online_manual.feature @@ -0,0 +1,40 @@ +Feature: online manual + As a user + I want to read the manual + So that I know how to do something in Noosfero + + Scenario: initial page of online manual + When I go to /doc + Then I should see "Noosfero online manual" + + Scenario: displaying index content + When I go to /doc + Then I should see "User features" + And I should see "Content Management" + + Scenario: displaying section + When I go to /doc + And I follow "User features" + Then I should see "Accepting friends" + And I should see "Commenting" + + Scenario: displaying topic + When I go to /doc + And I follow "User features" + And I follow "Commenting" + Then I should see "How to access" + + Scenario: adding title on browser + When I go to /doc + Then I should see "Online Manual - Colivre.net" + + Scenario: adding title on browser in a section + When I go to /doc + And I follow "User features" + Then I should see "User features - Online Manual - Colivre.net" + + Scenario: adding title on browser in a topic + When I go to /doc + And I follow "User features" + And I follow "Commenting articles" + Then I should see "Commenting articles - User features - Online Manual - Colivre.net" diff --git a/po/noosfero-doc.pot b/po/noosfero-doc.pot index 56ffef8..0f7cf77 100644 --- a/po/noosfero-doc.pot +++ b/po/noosfero-doc.pot @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" -"POT-Creation-Date: 2010-02-18 12:23-0300\n" +"POT-Creation-Date: 2010-03-03 17:35-0300\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -26,22 +26,22 @@ msgid "You can have a blog and publish posts on it." msgstr "" # type: Content of: