ConsoleUser

Copyright (c) 2010-2023 Skaion Corporarion, www.skaion.com

This project was developed in part by numerous sponsorships from the U.S. Government. The U.S. Government is authorized to reproduce and distribute reprints of Governmental purposes notwithstanding any copyright notation thereon.

All content reflects those of the authors and should not be interpreted as necessarily representing the official policies or endorsements, either expressed or implied, of the U.S. Government or Skaion Corporation.

class Etherpad.Etherpad(system, config)

This class is the abstract parent for clients that will use the Etherpad document editor.

Parameters:

  • system: a <no title> object to communicate with the target system

  • config: a <no title> object holding all our configuration

close_all(save=False)

Exit the application, closing all documents. By default this will not save changes to documents, but this can be overriden if desired.

Parameters:

  • save: whether or not to save changes to documents if prompted

close_document(save=False)

Because this only supports a single document at a time, this will almost always result in closing the browser.

Parameters:

  • save: whether or not to save the changes if prompted

load(path)

Load the document with the given name/path

Parameters:

  • path: the string name or path for the document to edit

new_document()

Start working on a new document.

save()

Save the current document

save_as(path)

Save the document to the given path.

Parameters:

  • path: the string path to type as the location for the saved doc