Ticket #855 (closed task: fixed)

Opened 2 years ago

Last modified 17 months ago

Migrate name change from pubapp to Ambra.

Reported by: amit Owned by: russ
Priority: low Milestone:
Component: ambra Version: 0.9-SNAPSHOT
Keywords: ambra namechange Cc:

Description

Start moving away from pubapp to Ambra. Not sure an entire cleanup can be done, but it needs to be started at least.

Change History

  Changed 2 years ago by amit

  • owner ronald deleted
  • component changed from topaz to publishing-app

  Changed 2 years ago by amit

  • owner set to russ

Russ, I am assigning this to you to be the co-ordinator on this one. Basic intent is to get PLoS branding out.

  Changed 2 years ago by amit

After thinking about this a little bit more, I am making this the master ticket for branding cleanup of the various applications (Registration, DOI, & PubApp? (Ambra)). Russ, since you have expressed a concern on this in the past, I am making you the ticket holder and co-ordinator. Some things to ensure:

  • Change of file names to make 'functional' sense and remove 'plos' everywhere.
  • Removal of 'plos' images and replacing them with generic images
  • As far as possible, remove plos name from everywhere (except package name)

Please work the the ticket holder of the sub-ordinated tickets to ensure it passes muster.

  Changed 2 years ago by russ

  • status changed from new to assigned
  • blockedby set to 638, 894, 525, 526, 527

  Changed 2 years ago by amit

  Changed 2 years ago by amit

(In [5412]) Addresses #525, #526, #527 and #855. Here are the list of things done here:

  • Removal of org.plos and org.plosone from <groupId> and changed that to org.topazproject
  • Removal of plosone and plos strings from <artifactId> and changed that to ambra
  • Removed topaz string from <artifactId> of ambra packages
  • Made ambra.xml the default configuration file

Please note: Ambra is already broken in 'head', and because of really slow network speeds I have not been able to test the rpms completely. I am going to have to do a clean build on black to test this thoroughly. If you don't want this to interfere with your work, do not do an 'svn update'.

  Changed 2 years ago by russ

estimated duration, 1 week, however i can't start work on this until

* 0.8.2.2 is released * head is fixed so i can build it * blocking tickets are resolved

in addition to the blocking tickets, i'd like to change files names and directory paths with PLoS in them. i'll bring this up in meeting after 0.8.2.2

  Changed 2 years ago by russ

todo:

  • config file updates
  • createjournal scripts for default journals
  • rename files and paths with "plos" in them if possible
  • find a way to override default css, image, javascript, ftl paths so that user template sets don't interfere with template sets in source.

  Changed 2 years ago by russ

amit made the excellent point that we can remove the journals/* folder, and the struts-journal.xml and the related freemarker config WITHOUT sacrificing any of the multi-journal functionality.

i'm thinking of copying plos-specific config files into my private branch, removing the journals/* folders altogether (sebastian can grab them from plos cvs repository).

there are still some questions about how to override the file lookup filter.

we'll also need to do something about the plosJournals folder and template. i think i can move this under journals/ as well...

  Changed 2 years ago by russ

can populate pub.virtualJournals.default.mappingPrefix to get a journals/plosone override

can add a struts-plosone.xml include to struts.xml to override actions

  Changed 2 years ago by amit

I am not convinced that deleting files under journals is the best way to go. After all there is nothing proprietary in the files there besides the name. We can think of them as different styles which a journal can potentially use (of course we change the names).

follow-up: ↓ 14   Changed 2 years ago by amit

To elaborate, why not change the name of journals/pathogens to say templates/template1 and journals/genetics to templates/template2 etc. and allow the journal definition to pick the template of choice. Why do we have to delete them?

  Changed 2 years ago by russ

(In [5516]) created journals/plosone directory. addresses #855

first step in separation of plosone and core assets. please pull in minor changes from packages/ambra/src/main/resources/ambra.xml.

in order to get this to work, i added <mappingPrefix> element to default journal definition, and created struts-plosone.xml override.

some plosone-only items were deleted from top level. some items were svn copied into journals/plosone which will allow sebastian to make generic versions of these files at the top level.

in reply to: ↑ 12   Changed 2 years ago by russ

Replying to amit:

To elaborate, why not change the name of journals/pathogens to say templates/template1 and journals/genetics to templates/template2 etc. and allow the journal definition to pick the template of choice. Why do we have to delete them?

amit:

we need to delete them so that, if some well-meaning contributor in the future decides to commit an awesome (but not really) change to journals/template1, plos doesn't unwittingly apply it to their production system on an upgrade.

i also don't think it will be useful for other users have have 6 extremely similar templates to choose from in core.

i think that having sebastian create a sparse default, and two dummy templates (#894) - that together incorporate examples of all the techniques we are currently using - will be a much more useful set of examples for a new user.


my other reason for wanting to remove the plos templates from core is functional. we make a lot of changes to the plos templates (especially static .ftl files) between upgrades. it's hard to merge those back into the topaz repository, and i'd like to get off that treadmill.


finally, it's a branding issue. i'm in favor of making the plos templates, or a snapshot of them, available somewhere in the repo for people to use as a learning tool. but i think this should be read-only/informational kind of thing. not a living piece of code for others to use and contribute to in the core journals directory.

  Changed 2 years ago by russ

(In [5518]) update defaults-dev to use journals/plosone template set addresses #855.

  Changed 2 years ago by amit

Contextual confusion. Russ has created #919 to deal with the overall issue of dealing with allowing users to have control of their own templates. This ticket will for now deal with removal of PLoS brand from default journals and moving PLoS journal templates to journals. Nothing will be deleted or removed till we have further visibility on #894.

  Changed 2 years ago by russ

(In [5551]) move virtual journal-specific conditional freemarker includes up one level, from global/ to templates/

addresses #855

until we find a way to expose the cascade filter inside freemarker templates, this will make templating a little more

  • flexible
  • standard (overrides are in the journals/* subfolder)
  • less invasive (only 2 files need to be touched)

  Changed 2 years ago by russ

(In [5565]) template separation

addresses #855

  • got rid of /plosJournals template folder, moved contents to global/user_*.ftl
  • created journals/plosJournals to serve as a location for shared plosJournal content
  • copied /templates/* to /journals/plosJournals/templates and removed plos-specific items from /templates/*
  • renamed plosOneFreemarker result-type to ambraFreemarker in struts.xml and struts-*.xml
  • pointed result-types in struts.xml to /journals/plosJournals/templates. this should be configurable, but unfortunately is not currently configurable.

  Changed 2 years ago by russ

(In [5566]) delete plosJournals directory

addresses #855

  Changed 2 years ago by russ

(In [5567]) move plos static pages into journals/plosJournals/static

addresses #855

update related config in struts.xml and various config.xml

  Changed 2 years ago by russ

(In [5568]) remove plos-specific ad-banner stuff from browse templates/main_template.ftl

addresses #855

also renamed pjou_*.css to user_*.css to match template name changes.

  Changed 2 years ago by russ

(In [5673]) move all journals/ambraJournal assets to top level and remove journals/ambraJournal folder.

addresses #855

  Changed 2 years ago by russ

(In [5679]) cleanup of jour_*.gif images renamed images related to user template to user_* updated css files to reflect new image names removed unused images updated registration webapp to match

addresses #855, #894

  Changed 2 years ago by russ

(In [5685]) break out plos-specific templates and assets for user templates, so that sebastian can work on genericizing this template.

renamed editPlosAlerts.ftl to editAmbraAlerts.ftl and updated struts.xml accordingly

separate google analytics include on a per-journal basis.

addresses #855, #894

  Changed 2 years ago by russ

  • priority changed from critical to medium

lowering priority as major work on this is complete, although a lot of little tweaks remain.

  Changed 2 years ago by amit

The notion here is that this becomes a background task for Russ. A lot of these tweaks can keep going in, but push come to shove we can go live with the existing changes (after #894).

  Changed 2 years ago by amit

  • priority changed from medium to low

  Changed 2 years ago by amit

  • status changed from assigned to new

  Changed 2 years ago by amit

  • status changed from new to closed
  • resolution set to fixed

Closing as from now on we need to identify specific set of changes in new tickets.

  Changed 17 months ago by anonymous

  • milestone 0.9.0 deleted

Milestone 0.9.0 deleted

Note: See TracTickets for help on using tickets.