Difference between revisions of "EDT4OL/Snapshot/Outline page"
From WikiEducator
(→Important Notes) |
JimTittsler (Talk | contribs) m (typos) |
||
| Line 1: | Line 1: | ||
[[image:Gears-and_question_mark.png|right|400px]]{{clear}} | [[image:Gears-and_question_mark.png|right|400px]]{{clear}} | ||
| − | In this section we provide a high level overview of the components of the wiki to | + | In this section we provide a high level overview of the components of the wiki to WordPress snapshot process so you are aware of the technical requirements of the snapshot process before you commence with the learning challenge to generate your first snapshot for a published course site. |
| Line 9: | Line 9: | ||
|title=Components of the snapshot process | |title=Components of the snapshot process | ||
|body=The snapshot process requires three major components: | |body=The snapshot process requires three major components: | ||
| − | # '''Outline page''' - A page in the wiki | + | # '''Outline page''' - A page in the wiki that is a structured list of the collection of wiki pages to be included in your snapshot that adheres to the [[EDT4OL/Snapshot/Design_constraints|technical requirements]] introduced previously in this section. In this course we will create an outline page as a sub-page of your User page in the wiki. |
# '''Snapshot widget''' - This is a special category of wiki markup that will insert a "Request snapshot" button on an outline page (see image below). It initiates a web-form for authenticated users to trigger the open source scripts that will publish a snapshot to a WordPress site. The widget contains the URL for the target WordPress site for publishing your outline of wiki pages. The widget also has the ability to incorporate institutional logos in the footer area of the published website and a custom link to a disclaimer page in the site footer if needed. However, in this course you will use a simplified version of the snapshot widget syntax.<br>[[image:Request-snapshot-button.png]] | # '''Snapshot widget''' - This is a special category of wiki markup that will insert a "Request snapshot" button on an outline page (see image below). It initiates a web-form for authenticated users to trigger the open source scripts that will publish a snapshot to a WordPress site. The widget contains the URL for the target WordPress site for publishing your outline of wiki pages. The widget also has the ability to incorporate institutional logos in the footer area of the published website and a custom link to a disclaimer page in the site footer if needed. However, in this course you will use a simplified version of the snapshot widget syntax.<br>[[image:Request-snapshot-button.png]] | ||
# '''WordPress course site''' - You will need access with administration rights to a WordPress site with the 'OERu theme' installed. The OERu WordPress theme incorporates the code needed to interpret the snapshot scripts for "converting" the wiki pages into WordPress pages. In this course, we provide learners with administration access to a WordPress course with a URL in the form of: <code><nowiki>https://edt4ol.oerfoundation.org/</nowiki>''username''-course</code> | # '''WordPress course site''' - You will need access with administration rights to a WordPress site with the 'OERu theme' installed. The OERu WordPress theme incorporates the code needed to interpret the snapshot scripts for "converting" the wiki pages into WordPress pages. In this course, we provide learners with administration access to a WordPress course with a URL in the form of: <code><nowiki>https://edt4ol.oerfoundation.org/</nowiki>''username''-course</code> | ||
| Line 16: | Line 16: | ||
==Authentication== | ==Authentication== | ||
| − | In open authoring environments like wikis, we need to incorporate authentication solutions to ensure that only authorised users can publish to your course website. Otherwise anyone in the wiki could request a snapshot to your course website without your permission. The snapshot process | + | In open authoring environments like wikis, we need to incorporate authentication solutions to ensure that only authorised users can publish to your course website. Otherwise anyone in the wiki could request a snapshot to your course website without your permission. The snapshot process requires two separate user credentials: |
# '''WikiEducator''': Your username and password to edit pages in WikiEducator. When requesting a snapshot, make sure that your WikiEducator session has not timed out. You can check this by refreshing your WikiEducator page in the browser. If you see your "Username link" at the top of the page, your editing session is still current. However, if you see a "Log in" link, your session has expired and you will need to login again before requesting a snapshot. Only authenticated WikiEducator users can request a snapshot, otherwise the snapshot will fail. | # '''WikiEducator''': Your username and password to edit pages in WikiEducator. When requesting a snapshot, make sure that your WikiEducator session has not timed out. You can check this by refreshing your WikiEducator page in the browser. If you see your "Username link" at the top of the page, your editing session is still current. However, if you see a "Log in" link, your session has expired and you will need to login again before requesting a snapshot. Only authenticated WikiEducator users can request a snapshot, otherwise the snapshot will fail. | ||
Revision as of 01:48, 22 April 2022
In this section we provide a high level overview of the components of the wiki to WordPress snapshot process so you are aware of the technical requirements of the snapshot process before you commence with the learning challenge to generate your first snapshot for a published course site.
Authentication
In open authoring environments like wikis, we need to incorporate authentication solutions to ensure that only authorised users can publish to your course website. Otherwise anyone in the wiki could request a snapshot to your course website without your permission. The snapshot process requires two separate user credentials:
- WikiEducator: Your username and password to edit pages in WikiEducator. When requesting a snapshot, make sure that your WikiEducator session has not timed out. You can check this by refreshing your WikiEducator page in the browser. If you see your "Username link" at the top of the page, your editing session is still current. However, if you see a "Log in" link, your session has expired and you will need to login again before requesting a snapshot. Only authenticated WikiEducator users can request a snapshot, otherwise the snapshot will fail.
- WordPress: Your username and password with administration rights on the
https://edt4ol.oerfoundation.org/username-coursesite. If you do not have administration rights on the WordPress target site, the snapshot will fail. This is to ensure that 3rd party users, without administrations rights on your site, are not able to publish content to your site.
Enter the correct user credentials when requesting a snapshot
It is important that you enter the correct credentials otherwise the snapshot will fail. After checking that your WikiEducator session is current (see above), when you click on the "Request snapshot" button, the following form will appear requesting user credentials:
Important Notes
- You must enter your Username and password for your WordPress user account. The WordPress site will check that you have administration credentials on the site URL specified before publishing content to the sight. Do not use your WikiEducator account credentials on this form, otherwise the snapshot will fail.
- The URL in the form should pre-populate with the URL for your course site in the form:
https://edt4ol.oerfoundation.org/username-course(this is specified when you set up the Snapshot widget on your course outline page for the first time. - Remember to use the password manager account you set up during the orientation of this course.
