Jump to content
apeisa

Multisite

Recommended Posts

(Added by Soma)

Note that this module is deprecated.

The newer and more maintained version is found here:

https://github.com/somatonic/Multisite/

You can get the current dev version here https://github.com/somatonic/Multisite/tree/dev

(Original Post)

Just pushed simple multisite module to github: https://github.com/a...ultisite.module


What this module does?
It allows you to run multiple sites with different domains run from single install, using same database. While you can easily do "subsites" like www.domain.com/campaign/, this allows you to turn that into www.campaign.com. This is nice stuff, when you have multiple simple sites, that all belong to same organisation and same people maintain.

How to use it?
Just create page with name like www.campaigndomain.com under your homepage, then edit this module through modules menu and add same domain there. If your domain resolves to same place where your main domain, it should just work. Please notice that if you have editing rights, it allows you to browse the site from www.olddomain.com/www.campaigndomain.com/, but users with no editing rights are redirected to www.campaigndomain.com (this is because session cookie is otherwise lost).

Any problems?
Not any real problems, at least yet known. Of course think twice when deciding should the site have own install instead of this. There are few benefits, like getting data from other sites, one admin view for all sites etc... but it can easily get out of the hands: number of templates, fields etc.. It is harder to maintain for sure.

Isn't there multisite support in core?
Yes, kind of. It is very different from this. It allows you to run multiple pw-installations with shared core files (/wire/ folder). This is totally different: this is single pw-installation which has multiple sites running from different domains.



This is basically just a wrapper with one config field for this little snippet Ryan posted here: http://processwire.c...ndpost__p__5578 (so most of the credit goes to Mr. Cramer here). What it also does is that it manipulates $page->path / url properties to have right subdomain value.

  • Like 9

Share this post


Link to post
Share on other sites

Antti, this looks fantastic. I'm pointing another domain to processwire.com so that I can test this out.

One suggestion that I have is to change this:

// If subdomain is visible on url, we might wanna redirect
if(strpos($_GET['it'],$subdomain) !== false) {
   // We don't redirect if one has editing access (because user would need to login on new domain also)
   $page = $this->pages->get("/". $_GET['it']);
   if(!$page->editable()) {
       $_GET['it'] = str_replace("{$subdomain}/", "", $_GET['it']);
       $this->session->redirect('http://' . $subdomain . '/' . $_GET['it']);
   }
}

…to this (or something like it, as I've not actually tested, but hopefully the intention is there): :)

// saved $_GET['it'], since PW unsets it after using it
// note this is an unsanitized variable, so only look at it, don't use it
protected $it;

public function init() { 
   $this->subdomainsArray = explode("\n", strtolower($this->subdomains));
   $this->it = ltrim($_GET['it'], '/');

   // ...then your existing code…

}

public function ready() {
   // if $this->subdomain was valid in init(), then no need to do more here.
   if($this->subdomain) return; 

   $subdomain = $this->page->rootParent->name; 
   // if rootParent->name isn't a subdomain, then no need to continue
   if(!in_array($subdomain, $this->subdomainsArray)) return;

   // if subdomain is visible on url, we might wanna redirect
   if(strpos($this->it, $subdomain) === 0 && !$this->page->editable()) { 
    $url = str_replace("/{$subdomain}/", '/', $this->page->httpUrl);
    $this->session->redirect(url); 
   }
}

The point of this is to avoid sending an unfiltered $_GET['it'] into $pages->get(), which may contain anything in it at that point. There's always a security concern with sending unfiltered input to any function that isn't expecting it. You can avoid the issue completely by moving the check into the ready() function, which gets called after PW has already validated the URL and determined the page. If you wanted to get more fancy with it, you could also foreach($input->urlSegments) and append $input->pageNum (if > 1), but I really don't think that's necessary.

  • Like 1

Share this post


Link to post
Share on other sites

Nice, apeisa. Some multisite features would be a great enhancement for PW. For example to provide a mobile site using a subdomain. So this is a nice step forward here. I have been experimenting on something like this several weeks ago, too, but then had to focus on some other modules. So I’m curious about your ideas.

Share this post


Link to post
Share on other sites

Ryan, thanks for suggestion. For some reason I thought that $_GET['it'] has only path values like /fdas/asd/ (like htaccess wouldn't send it to pw otherwise) but of course that isn't the case (we can have get parameters in url). I will update my code soon.

Oliver: you could definitely use this for m.domain.com type of stuff, actually a great use case for this module also. Many of our clients tend to have multiple smaller sites, that need to use data from main site, are maintained by same people, but usually have different marketing domain and own visuals. That is the original need for this module, but actually I would probably use this for m.domain.com type of mobile versions also.

Share this post


Link to post
Share on other sites

Just pushed changes made by Ryan. They went in almost exactly like that.

  • Like 2

Share this post


Link to post
Share on other sites

Hi Atti, thanks for your module! I am a bit confused about the usage, though... How am I supposed to access the backend? The module rewrites the URL so I can access my pages under the domain page, but the admin page can't be moved inside this domain page. But without that I cannot access it because the URL domain.com/processwire/ is catched by the module and tries to redirect to domain.com/domain.com/processwire which fails.

Thx for help!

edit: I changed line 40 into:

if(strpos($httpHost, $subdomain) !== false && strpos($httpHost, 'admin') !== false) {

which works for now. But I think this is not intended, so I would appreciate the "proper" solution ;-)

Another edit: How is the homepage supposed to work? Now it is the root page, but with several domains it would be nice to have several homepages (under the domain page or the domain page itself). What do you think?

Edited by MadeMyDay

Share this post


Link to post
Share on other sites

This is how we use this:

www.maindomain.com // This is the mainsite, runs just like any other pw-site

www.campaign.com // This is the first one using multisite, this domain is entered into module settings, but also as page under maindomain.com

www.anothercampaign.com // Just like the above

Admin for all these pages is accessible from www.maindomain.com/processwire/

First level of site tree from maindomain.com looks like this:

  • About Us
  • News
  • Contact us
  • Sitemap
  • www.campaign.com (hidden)
  • www.anothercampaign.com (hidden)

I won't suggest building very complicated setups with this, but it is superb for few specific campaign sites (especially if same people maintain or they reuse the data between). If you have many big sites under same site, you will end up with huge amount of templates & fields.

  • Like 1

Share this post


Link to post
Share on other sites

I would like to ask if it could be possible for a site with this module to have "the same" pages urls or processwire won't allow it to be made in any way? What I mean by "the same" is domain.com/particular-page and domain.net/particular-page or m.domain.com/particular-page. It would be very useful ie in case of desktop and mobile websites.

So I suppose the question is if page in ProcessWire has to have unique Name or we might have got pages with the same names under different "Categories".

website.com/race1/first-place

website.com/race1/second-place

website.com/race2/first-place

website.com/race2/second-place

?

Share this post


Link to post
Share on other sites

I am not sure I fully understand your question. Page name needs to be unique only among siblings. So your described page-tree is perfectly valid.

If you were asking if this module is suitable for offering same content for differend devices, then it is not intention of this module and that could be done in template level.

Share this post


Link to post
Share on other sites

Ok, I just rechecked and everything is working fine. So sorry for unnecessary question. I must have been very asleep when messing with it this night. I was doing stupid mistake - cloning a page and wanting to set the same name without moving it in a tree earlier. But if I didn't ask I probably wouldn't check it again.

Thanks :)

Share this post


Link to post
Share on other sites

@apeisa, thanks for this module -- it's working beautifully!

For our needs I had to implement support for alternative domains (each extra domain can have n alternatives, which all point to the same location.) With separate domains for development and secure addresses -- not to mention that in this case the client required alternative domains that couldn't be handled very well with just redirects -- that was pretty much the easiest way to put together a consistent experience.

So, basically I'm asking if you'd be interested in incorporating that addition in the main module if I sent you a pull request for it (of course once I've tested it properly first?) :)

Share this post


Link to post
Share on other sites

Sure. How are alternative domains setup in the config? Ie. how does the textarea scales here? Just commas between the different urls where the first one maps to the actual page?

Share this post


Link to post
Share on other sites

Pretty much like that, though at the moment only space is supported separator. Should probably add support for commas too, now that you mentioned it :)

Share this post


Link to post
Share on other sites

Currently I'm trying to get this to work, but I'm seriously questioning if I'm using this right. What I initially thought that had to do the following steps:

1) Make sure all the traffic from www.seconddomain.com points to the home directory of the www.maindomain.com. (checked)

2) Install the module and make sure that www.seconddomain.com is added to the textarea. (checked)

3) Create a new page with the template 'home' with the title matching the domain - in this case www.seconddomain.com. Status of the page is published and hidden. (checked)

Then I thought I have to add another page to make this work:

4) Create a page with a template underneath the 'second' homepage called 'Testpage'. Status of the page is published.

I can reach the page using the following URL:

http://www.maindomain.com/www.seconddomain.com/testpage/

But I can't reach the page using this URL:

http://www.seconddomain.com/testpage/

Things I've noticed

1. When I try to reach www.seconddomain.com it displays a 404 error.

2. The other items (like the primary navigation) on rootlevel are changed to www.seconddomain.com.

Thinking

Then I starting thinking (just about then ;) ): is this supposed to work like this?

The idea

I got a very simple site with three pages and the client really liked to the idea to create some landing pages using other domains but using the same structure. Hence I thought apeisa's Multisite could be used here.

Many thanks for any thoughts!

Share this post


Link to post
Share on other sites

Arjen, sorry to hear about problems. Your setup seems right to me.

Just to confirm: if you do remove the domain from module settings, you can use www.seconddomain.com and browse the "root site" normally? Also www.maindomain.com/www.seconddomain.com/ works and you can access that page normally?

Then if you try www.seconddomain.com is the 404 error msg generated by PW or Apache? Does the module do any redirects? What is visible on addressbar? Feel free to PM me any additional details if you want me to take closer look.

Share this post


Link to post
Share on other sites

If I remove the domain from the module setting I can browse the root site normally.

If I browse:

http://www.maindomain.com/www.seconddomain.com/

it loads the seconddomain homepage.

The 404 error is generated by PW. It doesn't redirect when I try to reach:

http://www.seconddomain.com/testpage/

I am using this with some subdomains. Could that be the issue here? The root site is located at:

http://clientdomainname.clients.mysite.com/

I will PM you in a short moment.

Share this post


Link to post
Share on other sites

I did forget to update this: there was an actual issue that is fixed now on latest commit. Thanks Arjen for finding and Teppo for fixing!

  • Like 3

Share this post


Link to post
Share on other sites

Hi,

with Options #1: multiple sites with multiple databases how

Sites can't easily share data with each other, since they are running independently from one another.

is hard?

I've 4 sites:

HQ (advertising and redirect to one of the children, in the future this control the newsletter sending operation and the main events calendar)

\_ site2

\_ site3

\_ site4

Site2 have the most users and contents.

Sites 2,3,4 can share a couple of "translator user".

HQ news/events must be viewed also in 2, 3 and 4.

Site2 specific news/events must be viewed in HQ, 3 and 4.

Only this.

Thanks,

Marco

Share this post


Link to post
Share on other sites

Unless I misunderstand, i think the answer is actually the module that this thread is about. Option 1 is for multiple databases that don't share data. Option 2 (this module) is the one you'd want with multiple sites sharing data.

Share this post


Link to post
Share on other sites

Hi Ryan,

you are right.

All ok, but in the pros and cons docs says can't easily, so I imagine that this can be done.

Which is the best way to have private database and template but share few info (e.g. global news) between the sites?

Share this post


Link to post
Share on other sites
Which is the best way to have private database and template but share few info (e.g. global news) between the sites?

The problem with having multiple sites pulling and/or manipulating from the same database is that the two sites become dependent upon one another. If something needs to change with the data source, then both sites need to change. If one site becomes compromised, both sites are compromised.

When two sites need to talk to each other, regardless of platform, the best practice is to use JSON or XML web services.

For the example you mentioned, and in the context of ProcessWire, I would use RSS feeds. Generate a feed of the data you want to share using the RSS Feed Generator module. Then output it on another site using the RSS Feed Loader module. Now you have two sites easily sharing data in a bulletproof manner.

For more complex needs, you might also want to check out the Pages Web Service module.

  • Like 2

Share this post


Link to post
Share on other sites

I have a website where the multisite module by apeia is running smoothly. One thing I can't get to work is how to share accounts on multiple sites. I've created an extra role called 'subscriber'. When I check:

if ($user->hasRole("subscriber")) {
echo "This is a subscriber.";
}

It's echoed on the mainsite.com, but it returns nothing (empty) on the otherdomain.com.

Then I checked:

echo $user->name;

It returns the $user->name on the mainsite.com, but again empty (actually guest) on the otherdomain.com.

Is this a session thing? Any thoughts on how to make a user who is logged in on the mainsite.com is also logged in on the subdomain.com?

Thanks!

Share this post


Link to post
Share on other sites

Sessions are based on cookies, which are domain spesific. So you need some kind of single sign on solution to share sessions between the domains.

  • Like 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
    • By Robin S
      This module is sort of an upgrade to my earlier ImageToMarkdown module, and might be useful to anyone working with Markdown in ProcessWire.
      Copy Markdown
      Adds icons to images and files that allow you to copy a Markdown string to the clipboard. When you click the icon a message at the top left of the screen notifies you that the copying has occurred.
      Screencast

      Note: in the screencast an EasyMDE inputfield is used to preview the Markdown. It's not required to use EasyMDE - an ordinary textarea field could be used.
      Usage: Images
      When you hover on an item in an Images field an asterisk icon appears on the thumbnail. Click the icon to copy an image Markdown string to clipboard. If the "Description" field is populated it is used as the alt text.
      You can also open the "Variations" modal for an image and click the asterisk icon to copy an image Markdown string for an individual variation.
      Usage: Files
      When you hover on an item in a Files field an asterisk icon appears next to the filename. Click the icon to copy a link Markdown string to the clipboard. If the "Description" field is populated it is used as the link text, otherwise the filename is used.
       
      https://github.com/Toutouwai/CopyMarkdown
      https://processwire.com/modules/copy-markdown/
    • By BitPoet
      I've realized that I've been jumping back and forth between the PW API docs and the source code for site modules far too much. The idea to hold all necessary documentation locally in one place has occurred to me before, but getting PHPDocumentor et al set up and running reliably (and producing readable output) as always been too much of a hassle. Today I was asked how I find the right hooks and their arguments, and that inspired me to finally get my backside down on the chair and whip something up, namely the
      Module Api Doc Viewer
      ProcessModuleApiDoc
      It lets you browse the inline documentation and public (optionally also protected) class/method/property information for all modules, core classes and template files in the ProcessWire instance. The documentation is generated on the fly, so you don't have to remember to update your docs whenever you update a module.
      The module is quite fresh, so expect some bugs there. Behind the scenes it uses PHP-Parser together with a custom class that extracts the information I needed, and the core TextformatterMarkdownExtra module for rendering the description part in the phpdoc style comments.
      This is not a replacement / competitor to the API Viewer included in the commercial ProDevTools package. There is quite some information included in the inline documentation that my module can't (and won't) parse, but which makes up parts of the official ProcessWire API docs.
      This, instead, is a kind of Swiss army knife to view PHPDoc style information and get a quick class or function reference.
      If you feel daring and want to give it a spin, or if you just want to read a bit more, visit the module's GitHub repository.
      This is the overview page under "Setup" -> "Module API Docs":

      And this is what the documentation for an individual class looks like:

      The core module documentation can of course be found online, but it didn't make sense not to include them.
      Let me know what you think!

×
×
  • Create New...