Comprehensive theming

336 views
Skip to first unread message

Mahyar Damavand

unread,
Aug 10, 2016, 11:41:57 AM8/10/16
to Open edX operations
I have a native installation of open Edx dogwood.3 on Ubuntu 12.04
and I want to customize its theme by enabling comprehensive theming
I did as this document said but I didn't see any changes.

I think it must be because of a caching or something like that because when i get a source view of my homepage I can see this line:

<link rel="stylesheet" href="/static/css/lms-main-rtl.40ec8342a978.css" type="text/css" media="all" />

and this file loads from here:
/edx/var/edxapp/staticfiles/css/lms-main-rtl.40ec8342a978.css

Can you help me ?

Regards,
Mahyar

Brandon DeRosier

unread,
Aug 10, 2016, 5:06:19 PM8/10/16
to opene...@googlegroups.com
Hi Mahyar,

The instructions you linked do work on the current edx:master, but comprehensive theming has changed quite a bit since Dogwood. To get comprehensive theming working in dogwood, try the following:

- Set "COMPREHENSIVE_THEME_DIR" to the actual directory of the theme, not it's parent directory (for example: "/edx/app/edxapp/edx-platform/themes/red-theme").
- Set "THEME_NAME" to be the name of the theme directory (i.e. "red-theme").
- Make sure "USE_CUSTOM_THEME" is false.

When using dogwood, it's not enough for the theme to simply override some include-only sass files (filenames that start with underscores), you'll need to supply overrides for lms-main.scss and/or lms-main-rtl.scss ("rtl" meaning "right-to-left"). See the version version of the test theme "red-theme" in Dogwood here: https://github.com/edx/edx-platform/tree/e8186a189fa7d62fc37e039297683154a6b98124/themes/red-theme/lms/static/sass

If you happen to be starting a new theme for dogwood, I'd recommend starting by pulling out either the "red-theme" or the "edx.org" into a new repository and modifying it.


Brandon

--
You received this message because you are subscribed to the Google Groups "Open edX operations" group.
To unsubscribe from this group and stop receiving emails from it, send an email to openedx-ops+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/openedx-ops/e563ae39-129a-4c7e-b84f-499c52cfd7bd%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Mahyar Damavand

unread,
Aug 13, 2016, 4:32:53 AM8/13/16
to opene...@googlegroups.com
Thank you very much Brandon,
I succeed to achieve my goal but I think there is another step which is not mentioned:
"You have to update assets after installing a new theme or changing an available one, if you want to see visual effects on the site"

then I have another question,
Is there any associated version documentation to prevent similar problems?
I mean for example an accurate document for dogwood.3 which I can use to enable comprehensive theming without getting confused?

Thanks a lot
Regards
Mahyar
Reply all
Reply to author
Forward
0 new messages