-
Notifications
You must be signed in to change notification settings - Fork 41
Template Locations
lhcramer edited this page Feb 1, 2018
·
1 revision
In addition to MapStory's scaffolding being in state of flux as refactoring and a move from MapLoom to Story Tools takes place, MapStory relies on several other projects for key interfaces and feature sets. For this reason, those new to the project may struggle to understand where to find specific templates and files to make changes to the UI.
Though the team is working to improve name spacing and project structure so that finding files and templates is more intuitive, in the mean time our hope is that this documentation will help provide some orientation.
Where possible, numbers that correspond to the site map above have been used.
Most pages on MapStory draw from these common templates.
-
Site Base - mapstory/mapstory/templates/site_base.html
Contains:
- the site's
<head>tag, which includes minified stylesheets and vendor scripts - the
<body>tag - plenty of
%includestatements to pull in the header, body, sidebar,%middle, footer,_site_scripts.html, etc.
- the site's
-
Header - mapstory/mapstory/templates/_header.html - Contains code for the site navigation for authenticated users and users who have not logged in. Includes
_login_register.html(see below). -
Site Scripts - mapstory/mapstory/templates/_site_scripts.html - Contains
<script>tags that bring in vendor JS, including autocomplete and OS Geo Importer. - Login/Register Modal - mapstory/mapstory/templates/_login_register.html - Contains code for the login modal—both the login form and the sign up form.
- Footer - mapstory/mapstory/templates/_footer.html - Contains code for the footer.
-
mapstory/mapstory/templates/index.html - Contains code for the home page. Note that
THEME == orangeis the proper MapStory.org site. Other themes in the code apply variations in the UI for customers who run a white labeled version of MapStory. - mapstory/mapstory/templates/mapstory/_extended_index.html - Contains the Community Initiatives and Sponsors areas of the homepage (which don't appear on white labeled versions of MapStory).
-
mapstory/mapstory/templates/search/searchn.html - Extends
site_base.htmland contains code for both the "Search for StoryTellers" and the "Search for Content" tabs of the Explore page. -
Sidebars
- mapstory/mapstory/templates/search/_sidebar_bestof.html - The Category list and Trending Tags on the Content page.
- mapstory/mapstory/templates/search/_refine_profiles.html - The "Refine Search" sidebar on the StoryTellers page.
-
Sorting
- mapstory/mapstory/templates/search/_sort_filters_content.html - The sorting filters below the search bar on the Content page.
- mapstory/mapstory/templates/search/_sort_filters_users.html - The sorting filters below the search bar on the StoryTellers page.
-
Results
- mapstory/mapstory/templates/search/_result_content.html - The results list of cards for Content.
- mapstory/mapstory/templates/search/_result_users.html - The results list of cards for StoryTellers.
-
mapstory/mapstory/templates/mapstory/getpage.html - Extends
site_base.html.
-
Home - mapstory/mapstory/journal/templates/journal/journal.html - Extends
site_base.html. - Write/Edit/Draft Journal Entry - mapstory/mapstory/journal/templates/journal/journal_edit.html
- Journal Detail Page (+ replies) - mapstory/mapstory/journal/templates/journal/journal_detail.html
- Both the Journal and Layer Detail pages use these templates. Templates are rendered along with logic that comes from an external library, Django Threaded Comments
- mapstory/mapstory/templates/comments/base.html
- mapstory/mapstory/templates/comments/comment.html
- mapstory/mapstory/templates/comments/form.html
- Import StoryLayer Modal - mapstory/mapstory/static/mapstory/partials/uploadWizard.html - Comes from OS Geo Importer
- Create StoryLayer - mapstory/mapstory/static/mapstory/partials/createLayerModal.html - Comes from OS Geo Importer
-
Upload Icons - mapstory/mapstory/templates/icons/icon_upload.html - Extends
site_base.html. -
Composer
- mapstory/mapstory/templates/composer/maploom.html - New Story.
- mapstory/mapstory/templates/composer/maploom.html - Return to draft (same template as new story).
-
Compose Story
- maploom/src/common/map/partial/mapproperties.tpl.html - Story properties modal. This is also where modals about publishing and saving a story live.
- maploom/src/common/sidebar/partials - Composer sidebars.
-
maploom/src/common/tour/partial/tour.tpl.html - Take a Tour, same as a new story +
maploom/src/common/tour/partial
-
mapstory/mapstory/templates/people/profile_edit.html - Comes from HTML generated by django in mapstory/mapstory/forms.py under
EditProfileForm.
-
mapstory/mapstory/templates/people/profile_edit.html - Comes from Django User Account's
changePasswordView. There are no templates or overrides for this in MapStory currently.
-
mapstory/mapstory/templates/people/profile_detail.html - HTML generated by django in mapstory/mapstory/notifications.py under
PROFILE_NOTICE_SETTINGS. - Redirects to profile page before loading the modal.
- TODO: Fill out this section.
- TODO: Fill out this section.
- TODO: Fill out this section.
- TODO: Fill out this section.
- TODO: Fill out this section.
Beta Baseline and Testing
- How to request a feature
- How to create a spike
- How to report a bug
- How to request a design story
- How to create a milestone
- Developer Setup
- Guidelines for Submitting a Pull Request
- HTML Styleguide
- CSS Styleguide
- Javascript Styleguide
- Python Styleguide
- Testing Guide
Project Architecture