|
1 .. _userguide: |
|
2 |
|
3 PyAMS Contributor's Guide |
|
4 ========================= |
|
5 |
|
6 Users or Site Managers |
|
7 Individuals who use PyAMS features to create a custom application or website. |
|
8 |
|
9 |
|
10 To Begin |
|
11 -------- |
|
12 |
|
13 Login |
|
14 ^^^^^ |
|
15 |
|
16 Begin by logging into the “administration area” or the back end of your website. |
|
17 Now log into PyAMS using your username and password. |
|
18 |
|
19 .. image:: _static/pyams-login.png |
|
20 |
|
21 |
|
22 Dashboard |
|
23 ^^^^^^^^^ |
|
24 |
|
25 After logging in you are on the main Administration Screen called the Dashboard. This is the starting point to create page and article |
|
26 also settings your workspace. If you are lost click on "Home" to come back on the Dashboard. |
|
27 |
|
28 .. image:: _static/pyams-dashboard.png |
|
29 |
|
30 |
|
31 |
|
32 At the top of the screen is the “toolbar”, this navigation menu is to create new publication content (site , article, view...) |
|
33 On the left side of the screen is the main navigation menu detailing each of the administrative functions you can perform. |
|
34 |
|
35 |
|
36 Article - The shared contents |
|
37 ----------------------------- |
|
38 |
|
39 |
|
40 Articles are sorted by category news, topic or long read, each category have different attributes, and they can quickly |
|
41 identify the type of content. |
|
42 |
|
43 The News are a short article to spotlight an information. This is typically the type of content used for blog posts or news feeds |
|
44 |
|
45 |
|
46 Create a News |
|
47 ^^^^^^^^^^^^^ |
|
48 |
|
49 To create a News, click on the "Shared contents" on the top bar and select "News" then click on **+ Add news topic** |
|
50 |
|
51 .. image:: _static/add_newtopic.png |
|
52 |
|
53 (*) The progress bar below the title is an indicator to optimize for indexation by search engines. |
|
54 |
|
55 When you are completed the form you will be redirected and invited to complete the properties of the article |
|
56 |
|
57 |
|
58 Manage a News |
|
59 ^^^^^^^^^^^^^ |
|
60 |
|
61 .. image:: _static/content_properties.png |
|
62 |
|
63 |
|
64 On this page you can modify the title and the url display, content description and write an unpublish note |
|
65 |
|
66 In Addition you can wrapped the articles with custom feature like: |
|
67 |
|
68 - A header or main illustration placed on the top of your article |
|
69 - An illustration for the links that targets the article. |
|
70 |
|
71 |
|
72 The interface also allows you to perform additional actions such as publishing and versioning but, we will come back to it later |
|
73 |
|
74 |
|
75 |
|
76 Edit the content of an article |
|
77 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
78 |
|
79 PyAMS offers a user-friendly interface for editing the content of an article, to do that, move on the side bar |
|
80 and the section **Composition** and click on **Contents...** |
|
81 |
|
82 .. image:: _static/select_paragraph.png |
|
83 |
|
84 An article is composed of many paragraphs or blocks. Depending on the configuration of the shared tool, |
|
85 one or more paragraphs may already be present when creating a new article to help the author structure his document. |
|
86 |
|
87 Each paragraph corresponds to a type of media and will facilitate the modification the articulation of an article. |
|
88 To add a new block, click **Add ..** |
|
89 |
|
90 .. image:: _static/content_paragraph.png |
|
91 |
|
92 (*) The list of available paragraph varies depending on the nature of the article and the configuration of the shared tools |
|
93 |
|
94 |
|
95 Paragraph |
|
96 --------- |
|
97 |
|
98 Header |
|
99 ^^^^^^ |
|
100 |
|
101 Rich Text |
|
102 ^^^^^^^^^ |
|
103 |
|
104 Illustration |
|
105 ^^^^^^^^^^^^ |
|
106 |
|
107 Media Gallery |
|
108 ^^^^^^^^^^^^^ |
|
109 |
|
110 Video |
|
111 ^^^^^ |
|
112 |
|
113 External video |
|
114 ^^^^^^^^^^^^^^ |
|
115 |
|
116 Audio |
|
117 ^^^^^ |
|
118 |
|
119 Associations |
|
120 ^^^^^^^^^^^^ |
|
121 |
|
122 Contact |
|
123 ^^^^^^^ |
|
124 |
|
125 Framed Text |
|
126 ^^^^^^^^^^^ |
|
127 |
|
128 Image Maps |
|
129 ^^^^^^^^^^ |
|
130 |
|
131 Key number |
|
132 ^^^^^^^^^^ |
|
133 |
|
134 Key point |
|
135 ^^^^^^^^^ |
|
136 |
|
137 Location number |
|
138 ^^^^^^^^^^^^^^^ |
|
139 |
|
140 Logos |
|
141 ^^^^^ |
|
142 |
|
143 Milestones |
|
144 ^^^^^^^^^^ |
|
145 |
|
146 Pictogram |
|
147 ^^^^^^^^^ |
|
148 |
|
149 Verbatim |
|
150 ^^^^^^^^ |
|
151 |
|
152 Raw HTML |
|
153 ^^^^^^^^ |
|
154 |
|
155 Verify the content |
|
156 ------------------ |
|
157 |
|
158 Audit |
|
159 ^^^^^ |
|
160 |
|
161 Preview |
|
162 ^^^^^^^ |
|
163 |
|
164 |
|
165 Publishing an Article |
|
166 --------------------- |
|
167 |
|
168 When you are writing an article, it's not already visible for the visitors, but when the content is ready the editor |
|
169 has the possibility to make a request by clicking on the button **Change status**. |
|
170 |
|
171 |
|
172 .. image:: _static/content_publish_toolbar.png |
|
173 |
|
174 |
|
175 You will be asked to validate the date of publication and check if the content corresponds to your expectations, |
|
176 |
|
177 .. image:: _static/content_publication_form.png |
|
178 |
|
179 |
|
180 If you work alone the validated content will be put online. |
|
181 |
|
182 |
|
183 If you have collaborators, you have the possibility to used a publication workflow that include reviewers. The editor |
|
184 make a **Request of publication** to the review for the validation of the request. Then, the reviewer receives a |
|
185 notification inviting him to consult the article in question. |
|
186 |
|
187 The reviewer has the choice to accept or refuse the publication or also create a new version of the article. |
|
188 |
|
189 |
|
190 .. warning:: |
|
191 |
|
192 **Important**: Once published the content can not be erased, |
|
193 However you can always unpublish it to remove the access to visitors. |
|
194 |
|
195 |
|
196 Web site Page / Blog |
|
197 -------------------- |
|
198 |
|
199 To create a new page for your website click on `Site tree` |
|
200 |
|
201 |
|
202 .. image:: _static/select_sitetree.png |
|
203 |
|
204 |
|
205 A blog or weblog is a simple editorial structure where news and topics are stacked in a chronological order. |
|
206 |
|
207 Click on **+ Add...** and choose the to create a `blog` or a `site manager` |
|
208 |
|
209 |
|
210 .. image:: _static/select_website_content.png |
|
211 |
|
212 |
|
213 |
|
214 How to link a shared content in the site ? |
|
215 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
216 |
|
217 |
|
218 Once the article is created, you will need to appear in your site or blog |
|
219 |
|
220 To link an article to a site or blog. |
|
221 |
|
222 - Click on "Rent content" |
|
223 |
|
224 .. image:: _static/site_add_content.png |
|
225 |
|
226 - Fill in the article internal reference. |
|
227 |
|
228 .. image:: _static/site_link_content.png |
|
229 |
|
230 - Article linked |
|
231 |
|
232 .. image:: _static/site_linked_content.png |
|
233 |
|
234 |
|
235 Website Design - Portal Templates |
|
236 --------------------------------- |
|
237 |
|
238 You can create a generic template shared for all users, to do that you need to have some webdesign privilege. |
|
239 |
|
240 |
|
241 On the `Control panel`, click on `Portal Templates` |
|
242 |
|
243 .. image:: _static/select_portlet.png |
|
244 |
|
245 For example In the Portal Templates menu |
|
246 |
|
247 .. image:: _static/user_create_template.png |
|
248 |
|
249 1) Click on **+add template** |
|
250 2) Name your new template |
|
251 3) Add a new **slot** |
|
252 4) Drag and drop a new portlet **image**. |
|
253 |
|
254 5) Click right on the portlet to **edit properties** or **delete** this elements. |
|
255 |
|
256 |
|
257 |
|
258 Apply a Template |
|
259 ^^^^^^^^^^^^^^^^ |
|
260 |
|
261 When you have defined a shared template, you can use it for your website |
|
262 |
|
263 .. image:: _static/nav_site_management.png |
|
264 |
|
265 |
|
266 If you choose to inherit from a template, select the template that you want to apply |
|
267 |
|
268 |
|
269 .. image:: _static/template_edit_config.png |
|
270 |
|
271 If you won't inherit from a shared template, you can create a local template. |
|
272 |
|
273 |
|
274 |