Transferring Files to Server
In order to view your XML files and images in TEI Boilerplate, they must be copied into the "content" and "image" folders of the file structure described on Understanding our Interface. To move files to the server, we use FTP (file transfer protocol).
Follow the steps outlined below.
Connecting to Server
- Install an FTP client on your computer. There are numerous clients that are available for free. Here are couple you might consider: Forklift (Mac), CyberDuck (Mac & PC).
- Launch the FTP client and choose the menu option or icon that allows you to create a new connection to a server (what this looks like this will vary, according to the client).
- Choose “FTP” (not “SFTP”) as the protocol.
- Under “Server,” enter the following: ftp.unfdhi.org.
- For username and password, enter the credentials provided by Dr. McCarl.
- Click “connect” (or similar, depending on client).
- Once a connection is established, you should see two file structures. One will be your local machine, and the other will be the server.
Copying XML Files
- Navigate to the folder named “content” on the server.
- Navigate to the folder where you have saved your current version of your XML file on your local machine.
- Drag the current version of your XML file from your local file structure to the “content” folder on the server. If this is the first time you transfer the file, it should simply copy over. If the file already exists on the server, you will be asked if you want to replace the existing copy. If you feel confident you’re doing the right thing, say yes and continue.
You will do this process every time you make changes to the XML and want to view the revised file on the server
Copying Images
- Navigate to the folder named “images” on the server.
- Navigate to the folder where you have saved your current version of your XML file on your local machine.
- Drag the current version of your XML file from your local file structure to the “images” folder on the server.
You will do this process only once, unless there is a need to change something related to an image file after it is placed on the server.
Exercising Caution When Copying
You must exercise caution when moving files to the server.
Don't overwrite your own files on local machine
It can sometimes be easy to confuse the two panes in your FTP client, and accidentally drag in the wrong direction. Some FTP clients do not always open the remote and local file structures in the same panes, so you really need to be careful to make sure you’re dragging from your local machine to the server. If you were to do the opposite (drag from server to local), you would end up overwriting your updated file with the outdated copy on the server.
For this reason, it is always advisable to make a backup of your current file before you initiate any FTP transfer session. You can do this by making a copy of the file in the same folder on your local machine, with the date and the term “backup” added, as in “myxmlfile 20201001 backup.xml.” You could also create a subfolder for each time you do an FTP transfer, bearing the date, and copy the file there without needing to change the filename.
Don't interfere with others' files on server
Ideally, we would have controls in place that would allow every student to ftp their materials to unique locations. Unfortunately, at the moment we do not have that capability, and everyone is placing their materials in the same "content" and "image" folders on the server. Therefore, it is important that you don't accidentally delete or alter anything on the server. The only files you should deal with there are your own.
Consider your local copy always the master copy
If we were to have a problem with the TEI-Boilerplate site, we would start from scratch. I would recreate the site, and then everyone would transfer their XML files and images again. Therefore, it's important to think of what is on the server as only a copy. Your master copies of your files will always be the ones you retain remotely on your local machines. This will only change at the end of the term, when we will consider what is on TEI-Boilerplate to be the definitive versions.
Viewing Your File
The URL for your XML file will be
https://unfdhi.org/nfew-editions/content/filename.xml
where "filename" is the name of your XML file (as you named it on Naming Files).
Navigate to this URL in a browser to see your file.
If you have opened the file in a browser previously, made changes to the XML, and re-transferred the file to the server, you will need to refresh the page to see the changes.